Download OpenAPI specification:Download
Unite US API.
© 2020 Unite US, Inc. All Rights Reserved.| group_id required | string |
| phone_numbers[phone_number][phone_number] required | string The phone number itself. Minimum 7 digits, only numbers will be stored. |
| group[name] | string The name of the address book group. |
| group[description] | string Description of the address book group |
| group[founded_year] | number The year the group was founded. |
| group[status] | string Enum: "draft" "in_review" "published" "archived" Status of the address book group |
| group[primary_contact_name] | string Primary contact name of the address book group |
| email_addresses | Array of strings |
| addresses | Array of strings |
| phone_numbers[phone_number][is_primary] | boolean Is this phone number the group's primary group number |
| phone_numbers[phone_number][phone_type] | string Enum: "work" "mobile" "fax" "unknown" Type of phone number. |
| phone_numbers[phone_number][can_sms] | boolean Can this phone number receive SMS? |
| phone_numbers[phone_number][country_code] | string Country code for the phone number. Defaults to 1, if not specified. |
| schedule[week] | Array of strings The hours of operation for the provided day |
| service_types | Array of strings The uuids of the service type(s) |
{- "phone_numbers[phone_number][phone_number]": "string",
- "group[name]": "string",
- "group[description]": "string",
- "group[founded_year]": 0,
- "group[status]": "draft",
- "group[primary_contact_name]": "string",
- "email_addresses": [
- "string"
], - "addresses": [
- "string"
], - "phone_numbers[phone_number][is_primary]": true,
- "phone_numbers[phone_number][phone_type]": "work",
- "phone_numbers[phone_number][can_sms]": true,
- "phone_numbers[phone_number][country_code]": "string",
- "schedule[week]": [
- "string"
], - "service_types": [
- "string"
]
}| id required | string |
| group_id required | string |
| phone_numbers[phone_number][phone_number] required | string The phone number itself. Minimum 7 digits, only numbers will be stored. |
| group[name] | string The name of the address book group. |
| group[description] | string Description of the address book group |
| group[founded_year] | number The year the group was founded. |
| group[status] | string Enum: "draft" "in_review" "published" "archived" Status of the address book group |
| group[primary_contact_name] | string Primary contact name of the address book group |
| email_addresses | Array of strings |
| addresses | Array of strings |
| phone_numbers[phone_number][is_primary] | boolean Is this phone number the group's primary group number |
| phone_numbers[phone_number][phone_type] | string Enum: "work" "mobile" "fax" "unknown" Type of phone number. |
| phone_numbers[phone_number][can_sms] | boolean Can this phone number receive SMS? |
| phone_numbers[phone_number][country_code] | string Country code for the phone number. Defaults to 1, if not specified. |
| schedule[week] | Array of strings The hours of operation for the provided day |
| service_types | Array of strings The uuids of the service type(s) |
{- "phone_numbers[phone_number][phone_number]": "string",
- "group[name]": "string",
- "group[description]": "string",
- "group[founded_year]": 0,
- "group[status]": "draft",
- "group[primary_contact_name]": "string",
- "email_addresses": [
- "string"
], - "addresses": [
- "string"
], - "phone_numbers[phone_number][is_primary]": true,
- "phone_numbers[phone_number][phone_type]": "work",
- "phone_numbers[phone_number][can_sms]": true,
- "phone_numbers[phone_number][country_code]": "string",
- "schedule[week]": [
- "string"
], - "service_types": [
- "string"
]
}| id required | string |
| group_id required | string |
| phone_numbers[phone_number][phone_number] required | string The phone number itself. Minimum 7 digits, only numbers will be stored. |
| group[name] | string The name of the address book group. |
| group[description] | string Description of the address book group |
| group[founded_year] | number The year the group was founded. |
| group[status] | string Enum: "draft" "in_review" "published" "archived" Status of the address book group |
| group[primary_contact_name] | string Primary contact name of the address book group |
| email_addresses | Array of strings |
| addresses | Array of strings |
| phone_numbers[phone_number][is_primary] | boolean Is this phone number the group's primary group number |
| phone_numbers[phone_number][phone_type] | string Enum: "work" "mobile" "fax" "unknown" Type of phone number. |
| phone_numbers[phone_number][can_sms] | boolean Can this phone number receive SMS? |
| phone_numbers[phone_number][country_code] | string Country code for the phone number. Defaults to 1, if not specified. |
| schedule[week] | Array of strings The hours of operation for the provided day |
| service_types | Array of strings The uuids of the service type(s) |
{- "phone_numbers[phone_number][phone_number]": "string",
- "group[name]": "string",
- "group[description]": "string",
- "group[founded_year]": 0,
- "group[status]": "draft",
- "group[primary_contact_name]": "string",
- "email_addresses": [
- "string"
], - "addresses": [
- "string"
], - "phone_numbers[phone_number][is_primary]": true,
- "phone_numbers[phone_number][phone_type]": "work",
- "phone_numbers[phone_number][can_sms]": true,
- "phone_numbers[phone_number][country_code]": "string",
- "schedule[week]": [
- "string"
], - "service_types": [
- "string"
]
}| contact_id required | string |
| group_id required | string |
| consent[signature_image] | string Base64 of the signature image |
{- "consent[signature_image]": "string"
}Filtered activity stream or timeline events are returned loosely based on the Activity Stream specification (activitystrea.ms).
Available verb values include: accept,
add, assign, close,
complete, create, delete,
deny, join, leave,
open, post, replace,
retract, save, send, and
update.
Use the verb, object, and target values to determine the event that occurred.
| assistance_request_id required | string |
| group_id required | string |
| q[filter_names] | string Enum: "client_updates" "closed_records" "notes" "record_updates" "network_updates" "care_team" Name of filter to be appliied |
| page | number The page of results to be returned. |
| per | number The number of records to be returned per page. |
| sord | string Enum: "asc" "desc" The order to sort the results. |
| sidx | string The attribute to sort the results by. |
{- "q[filter_names]": "client_updates",
- "page": 0,
- "per": 0,
- "sord": "asc",
- "sidx": "string"
}Activity Stream or Timeline events are returned loosely based on the Activity Stream specification (activitystrea.ms).
Available verb values include: accept,
add, assign, close,
complete, create, delete,
deny, join, leave,
open, post, replace,
retract, save, send, and
update.
Use the verb, object, and target values to determine the event that occurred.
| assistance_request_id required | string |
| group_id required | string |
| page | number The page of results to be returned. |
| per | number The number of records to be returned per page. |
| sord | string Enum: "asc" "desc" The order to sort the results. |
| sidx | string The attribute to sort the results by. |
Validates the supplied authentication token to allow a client to determine
if the token is valid or not. A 200 OK response will be issued
to indicate the token is valid. A 401 UNAUTHORIZED response
will be issued to indicate the token is not valid.
| access_token required | string Bearer token to validate. Should be formatted as 'Bearer TOKEN_VALUE' |
{- "access_token": "string"
}Create a new group form.
| form[name] | string Name of the form. |
| form[notes_text] | string Additional notes or description to help identify the form. |
| form[is_active] | boolean Is the form active or inactive. |
{- "form[name]": "string",
- "form[notes_text]": "string",
- "form[is_active]": true
}Apply an update to an existing group form.
| id required | string |
| form[name] | string Name of the form. |
| form[notes_text] | string Additional notes or description to help identify the form. |
| form[is_active] | boolean Is the form active or inactive. |
{- "form[name]": "string",
- "form[notes_text]": "string",
- "form[is_active]": true
}Apply an update to an existing group form.
| id required | string |
| form[name] | string Name of the form. |
| form[notes_text] | string Additional notes or description to help identify the form. |
| form[is_active] | boolean Is the form active or inactive. |
{- "form[name]": "string",
- "form[notes_text]": "string",
- "form[is_active]": true
}Create a new question and adds it to the selected form.
| form_id required | string |
| question[conditional_display][show_or_hide_question_id] required | string Identifier of the question to be shown or hide. |
| question[conditional_display][show_or_hide] required | string Enum: "show" "hide" Show or hide the specified question based on the conditions. |
| question[display_order] required | number The position of the question within the question list display. If within a section, the order is scoped. |
| question[label_text] required | string The label text to be displayed for the question. |
| question[section_id] | string Identifier of the form section this question belongs to |
| question[placeholder_text] | string Placeholder text to be displayed within the input, if supported by the browser. |
| question[help_text] | string Help text to be displayed with the question. |
| question[help_text_position] | string Enum: "before_input" "after_input" Where to position the help text, if help text is provided. |
| question[is_required] | boolean Is this question required to be completed? |
| question[min_selections] | number If the question is a selection-based question (drop-down, checkbox list, etc.), what is the minimum number of selections that must be made. |
| question[max_selections] | number If the question is a selection-based question (drop-down, checkbox list, etc.), what is the maximum number of selections that may be made. |
| question[input_options] | Array of strings |
| question[conditional_display][and_conditions] | Array of strings |
| question[conditional_display][or_conditions] | Array of strings |
{- "question[conditional_display][show_or_hide_question_id]": "string",
- "question[conditional_display][show_or_hide]": "show",
- "question[display_order]": 0,
- "question[label_text]": "string",
- "question[section_id]": "string",
- "question[placeholder_text]": "string",
- "question[help_text]": "string",
- "question[help_text_position]": "before_input",
- "question[is_required]": true,
- "question[min_selections]": 0,
- "question[max_selections]": 0,
- "question[input_options]": [
- "string"
], - "question[conditional_display][and_conditions]": [
- "string"
], - "question[conditional_display][or_conditions]": [
- "string"
]
}Update an existing question. Performing an update does not change any existing responses to the question.
| id required | string |
| form_id required | string |
| question[section_id] | string Identifier of the form section this question belongs to |
| question[label_text] | string The label text to be displayed for the question. |
| question[placeholder_text] | string Placeholder text to be displayed within the input, if supported by the browser. |
| question[help_text] | string Help text to be displayed with the question. |
| question[help_text_position] | string Enum: "before_input" "after_input" Where to position the help text, if help text is provided. |
| question[display_order] | number The position of the question within the question list display. If within a section, the order is scoped. |
| question[is_required] | boolean Is this question required to be completed? |
| question[min_selections] | number If the question is a selection-based question (drop-down, checkbox list, etc.), what is the minimum number of selections that must be made. |
| question[max_selections] | number If the question is a selection-based question (drop-down, checkbox list, etc.), what is the maximum number of selections that may be made. |
| question[input_options] | Array of strings |
| question[conditional_display][show_or_hide] | string Enum: "show" "hide" Show or hide the specified question based on the conditions. |
| question[conditional_display][show_or_hide_question_id] | string Identifier of the question to be shown or hide. |
| question[conditional_display][and_conditions] | Array of strings |
| question[conditional_display][or_conditions] | Array of strings |
{- "question[section_id]": "string",
- "question[label_text]": "string",
- "question[placeholder_text]": "string",
- "question[help_text]": "string",
- "question[help_text_position]": "before_input",
- "question[display_order]": 0,
- "question[is_required]": true,
- "question[min_selections]": 0,
- "question[max_selections]": 0,
- "question[input_options]": [
- "string"
], - "question[conditional_display][show_or_hide]": "show",
- "question[conditional_display][show_or_hide_question_id]": "string",
- "question[conditional_display][and_conditions]": [
- "string"
], - "question[conditional_display][or_conditions]": [
- "string"
]
}Update an existing question. Performing an update does not change any existing responses to the question.
| id required | string |
| form_id required | string |
| question[section_id] | string Identifier of the form section this question belongs to |
| question[label_text] | string The label text to be displayed for the question. |
| question[placeholder_text] | string Placeholder text to be displayed within the input, if supported by the browser. |
| question[help_text] | string Help text to be displayed with the question. |
| question[help_text_position] | string Enum: "before_input" "after_input" Where to position the help text, if help text is provided. |
| question[display_order] | number The position of the question within the question list display. If within a section, the order is scoped. |
| question[is_required] | boolean Is this question required to be completed? |
| question[min_selections] | number If the question is a selection-based question (drop-down, checkbox list, etc.), what is the minimum number of selections that must be made. |
| question[max_selections] | number If the question is a selection-based question (drop-down, checkbox list, etc.), what is the maximum number of selections that may be made. |
| question[input_options] | Array of strings |
| question[conditional_display][show_or_hide] | string Enum: "show" "hide" Show or hide the specified question based on the conditions. |
| question[conditional_display][show_or_hide_question_id] | string Identifier of the question to be shown or hide. |
| question[conditional_display][and_conditions] | Array of strings |
| question[conditional_display][or_conditions] | Array of strings |
{- "question[section_id]": "string",
- "question[label_text]": "string",
- "question[placeholder_text]": "string",
- "question[help_text]": "string",
- "question[help_text_position]": "before_input",
- "question[display_order]": 0,
- "question[is_required]": true,
- "question[min_selections]": 0,
- "question[max_selections]": 0,
- "question[input_options]": [
- "string"
], - "question[conditional_display][show_or_hide]": "show",
- "question[conditional_display][show_or_hide_question_id]": "string",
- "question[conditional_display][and_conditions]": [
- "string"
], - "question[conditional_display][or_conditions]": [
- "string"
]
}| question_id required | string |
| form_id required | string |
| input_option[display_order] required | number The position within the form that this section should appear. |
| input_option[base_input_option_id] required | string Identifier of the base input option from the global repository. Required for non create actions. |
| input_option[option_label] required | string The label to be displayed to users completing a form with this question and input option. |
{- "input_option[display_order]": 0,
- "input_option[base_input_option_id]": "string",
- "input_option[option_label]": "string"
}| id required | string |
| question_id required | string |
| form_id required | string |
| input_option[display_order] required | number The position within the form that this section should appear. |
| input_option[base_input_option_id] required | string Identifier of the base input option from the global repository. Required for non create actions. |
| input_option[option_label] required | string The label to be displayed to users completing a form with this question and input option. |
{- "input_option[display_order]": 0,
- "input_option[base_input_option_id]": "string",
- "input_option[option_label]": "string"
}| id required | string |
| question_id required | string |
| form_id required | string |
| input_option[display_order] required | number The position within the form that this section should appear. |
| input_option[base_input_option_id] required | string Identifier of the base input option from the global repository. Required for non create actions. |
| input_option[option_label] required | string The label to be displayed to users completing a form with this question and input option. |
{- "input_option[display_order]": 0,
- "input_option[base_input_option_id]": "string",
- "input_option[option_label]": "string"
}| form_id required | string |
| section[display_order] required | number The position within the form that this section should appear. |
| section[display_name] required | boolean Should the name of the section be displayed to the user. |
| section[name] required | string The name of the section. |
| section[section_type] | string Enum: "form_group" "break" The type of the section. A break would typically appear as a horizontal rule or similar on a form. |
{- "section[display_order]": 0,
- "section[display_name]": true,
- "section[name]": "string",
- "section[section_type]": "form_group"
}| id required | string |
| form_id required | string |
| section[display_order] required | number The position within the form that this section should appear. |
| section[display_name] required | boolean Should the name of the section be displayed to the user. |
| section[name] required | string The name of the section. |
| section[section_type] | string Enum: "form_group" "break" The type of the section. A break would typically appear as a horizontal rule or similar on a form. |
{- "section[display_order]": 0,
- "section[display_name]": true,
- "section[name]": "string",
- "section[section_type]": "form_group"
}| id required | string |
| form_id required | string |
| section[display_order] required | number The position within the form that this section should appear. |
| section[display_name] required | boolean Should the name of the section be displayed to the user. |
| section[name] required | string The name of the section. |
| section[section_type] | string Enum: "form_group" "break" The type of the section. A break would typically appear as a horizontal rule or similar on a form. |
{- "section[display_order]": 0,
- "section[display_name]": true,
- "section[name]": "string",
- "section[section_type]": "form_group"
}| q[text] required | string The keyword or phrase to use when searching the questions repository. |
| q[search_core] | boolean T/F for if we are searching Forms::Core or Forms::Forms |
{- "q[text]": "string",
- "q[search_core]": true
}| q[search_term] required | string The keyword or phrase to search for |
| q[limit_to_attributes] | Array of strings An array of strings of attributes to constraint the search by. ['email', 'name']. Can be nil |
| q[return_attributes] | Array of strings Array of attributes to return in the serialization of the results. ['name', 'id'] |
| take | number The maximum number of results to be returned. Can be nil. |
{- "q[search_term]": "string",
- "q[limit_to_attributes]": [
- "string"
], - "q[return_attributes]": [
- "string"
], - "take": 0
}| question_id required | string |
| form_id required | string |
| question[section_id] required | string The new section ID that we are moving the question to. |
{- "question[section_id]": "string"
}| id required | string |
| group_id required | string |
| use_type | string Enum: "intake" "exit" "general" "screening" How should the form be used. |
| service_types | Array of strings An array of Service Type identifiers that the form usage should be associated with. |
| id required | string |
| group_id required | string |
| form_id required | string |
| usage[use_type] required | string Enum: "intake" "exit" "general" "screening" How should the form be used now. |
| usage[current_use_type] required | string Enum: "intake" "exit" "general" "screening" How should the form is currently being used. |
| usage[service_types] | Array of strings An array of Service Type identifiers that the form usage should be associated with. |
{- "usage[use_type]": "intake",
- "usage[current_use_type]": "intake",
- "usage[service_types]": [
- "string"
]
}| id required | string |
| group_id required | string |
| form_id required | string |
| usage[use_type] required | string Enum: "intake" "exit" "general" "screening" How should the form be used. |
| usage[service_types] | Array of strings An array of Service Type identifiers that the form usage should be associated with. |
{- "usage[use_type]": "intake",
- "usage[service_types]": [
- "string"
]
}| id required | string |
| group_id required | string |
| form_id required | string |
| use_type | string Enum: "intake" "exit" "general" "screening" How should the form be used. |
{- "use_type": "intake"
}| id required | string |
| group_id required | string |
| form_id required | string |
| usage[use_type] required | string Enum: "intake" "exit" "general" "screening" How should the form be used now. |
| usage[current_use_type] required | string Enum: "intake" "exit" "general" "screening" How should the form is currently being used. |
| usage[service_types] | Array of strings An array of Service Type identifiers that the form usage should be associated with. |
{- "usage[use_type]": "intake",
- "usage[current_use_type]": "intake",
- "usage[service_types]": [
- "string"
]
}| id required | string |
| form_id required | string |
| usage[use_type] required | string Enum: "intake" "exit" "general" "screening" How should the form be used now. |
| usage[current_use_type] required | string Enum: "intake" "exit" "general" "screening" How should the form is currently being used. |
| usage[service_types] | Array of strings An array of Service Type identifiers that the form usage should be associated with. |
{- "usage[use_type]": "intake",
- "usage[current_use_type]": "intake",
- "usage[service_types]": [
- "string"
]
}| id required | string |
| form_id required | string |
| usage[use_type] required | string Enum: "intake" "exit" "general" "screening" How should the form be used. |
| usage[service_types] | Array of strings An array of Service Type identifiers that the form usage should be associated with. |
{- "usage[use_type]": "intake",
- "usage[service_types]": [
- "string"
]
}| id required | string |
| form_id required | string |
| use_type | string Enum: "intake" "exit" "general" "screening" How should the form be used. |
{- "use_type": "intake"
}| id required | string |
| form_id required | string |
| usage[use_type] required | string Enum: "intake" "exit" "general" "screening" How should the form be used now. |
| usage[current_use_type] required | string Enum: "intake" "exit" "general" "screening" How should the form is currently being used. |
| usage[service_types] | Array of strings An array of Service Type identifiers that the form usage should be associated with. |
{- "usage[use_type]": "intake",
- "usage[current_use_type]": "intake",
- "usage[service_types]": [
- "string"
]
}| id required | string |
| form_id required | string |
| usage[use_type] required | string Enum: "intake" "exit" "general" "screening" How should the form be used now. |
| usage[current_use_type] required | string Enum: "intake" "exit" "general" "screening" How should the form is currently being used. |
| usage[service_types] | Array of strings An array of Service Type identifiers that the form usage should be associated with. |
{- "usage[use_type]": "intake",
- "usage[current_use_type]": "intake",
- "usage[service_types]": [
- "string"
]
}| id required | string |
| form_id required | string |
| usage[use_type] required | string Enum: "intake" "exit" "general" "screening" How should the form be used. |
| usage[service_types] | Array of strings An array of Service Type identifiers that the form usage should be associated with. |
{- "usage[use_type]": "intake",
- "usage[service_types]": [
- "string"
]
}| id required | string |
| form_id required | string |
| use_type | string Enum: "intake" "exit" "general" "screening" How should the form be used. |
{- "use_type": "intake"
}| id required | string |
| form_id required | string |
| usage[use_type] required | string Enum: "intake" "exit" "general" "screening" How should the form be used now. |
| usage[current_use_type] required | string Enum: "intake" "exit" "general" "screening" How should the form is currently being used. |
| usage[service_types] | Array of strings An array of Service Type identifiers that the form usage should be associated with. |
{- "usage[use_type]": "intake",
- "usage[current_use_type]": "intake",
- "usage[service_types]": [
- "string"
]
}| member_id required | string |
| contact_id required | string |
| group_id required | string |
| address[country] required | string Country for the address. |
| address[state] required | string State or province for the address. |
| address[postal_code] required | string Postal or ZIP code for the address. Minimum 5 characters in length, maximum 15. |
| address[city] required | string City or town of the address. |
| address[address_type] required | string Enum: "home" "mailing" "work" "unknown" Type of address. |
| address[line_1] | string Address line 1 |
| address[line_2] | string Additional address details, ex. apartment, suite, etc. |
| address[is_mailing_address] | boolean Is this a mailing address. |
{- "address[country]": "string",
- "address[state]": "string",
- "address[postal_code]": "string",
- "address[city]": "string",
- "address[address_type]": "home",
- "address[line_1]": "string",
- "address[line_2]": "string",
- "address[is_mailing_address]": true
}| id required | string |
| member_id required | string |
| contact_id required | string |
| group_id required | string |
| address[country] required | string Country for the address. |
| address[state] required | string State or province for the address. |
| address[postal_code] required | string Postal or ZIP code for the address. Minimum 5 characters in length, maximum 15. |
| address[city] required | string City or town of the address. |
| address[address_type] required | string Enum: "home" "mailing" "work" "unknown" Type of address. |
| address[line_1] | string Address line 1 |
| address[line_2] | string Additional address details, ex. apartment, suite, etc. |
| address[is_mailing_address] | boolean Is this a mailing address. |
{- "address[country]": "string",
- "address[state]": "string",
- "address[postal_code]": "string",
- "address[city]": "string",
- "address[address_type]": "home",
- "address[line_1]": "string",
- "address[line_2]": "string",
- "address[is_mailing_address]": true
}| id required | string |
| member_id required | string |
| contact_id required | string |
| group_id required | string |
| address[country] required | string Country for the address. |
| address[state] required | string State or province for the address. |
| address[postal_code] required | string Postal or ZIP code for the address. Minimum 5 characters in length, maximum 15. |
| address[city] required | string City or town of the address. |
| address[address_type] required | string Enum: "home" "mailing" "work" "unknown" Type of address. |
| address[line_1] | string Address line 1 |
| address[line_2] | string Additional address details, ex. apartment, suite, etc. |
| address[is_mailing_address] | boolean Is this a mailing address. |
{- "address[country]": "string",
- "address[state]": "string",
- "address[postal_code]": "string",
- "address[city]": "string",
- "address[address_type]": "home",
- "address[line_1]": "string",
- "address[line_2]": "string",
- "address[is_mailing_address]": true
}| member_id required | string |
| contact_id required | string |
| group_id required | string |
| email_address[email_address] required | string A valid email address |
| email_address[is_primary] | boolean Is this email address the primary one for the care team member. |
{- "email_address[email_address]": "string",
- "email_address[is_primary]": true
}| id required | string |
| member_id required | string |
| contact_id required | string |
| group_id required | string |
| email_address[email_address] required | string A valid email address |
| email_address[is_primary] | boolean Is this email address the primary one for the care team member. |
{- "email_address[email_address]": "string",
- "email_address[is_primary]": true
}| id required | string |
| member_id required | string |
| contact_id required | string |
| group_id required | string |
| email_address[email_address] required | string A valid email address |
| email_address[is_primary] | boolean Is this email address the primary one for the care team member. |
{- "email_address[email_address]": "string",
- "email_address[is_primary]": true
}| member_id required | string |
| contact_id required | string |
| group_id required | string |
| phone_number[phone_number] required | string The phone number itself. Minimum 7 digits, only numbers will be stored. |
| phone_number[is_primary] | boolean Is this phone number the care team member's primary contact number. |
| phone_number[phone_type] | string Enum: "mobile" "home" "work" "fax" "unknown" Type of phone number. |
| phone_number[can_sms] | boolean Can this phone number receive SMS? |
| phone_number[country_code] | string Country code for the phone number. Defaults to 1, if not specified. |
{- "phone_number[phone_number]": "string",
- "phone_number[is_primary]": true,
- "phone_number[phone_type]": "mobile",
- "phone_number[can_sms]": true,
- "phone_number[country_code]": "string"
}| id required | string |
| member_id required | string |
| contact_id required | string |
| group_id required | string |
| phone_number[phone_number] required | string The phone number itself. Minimum 7 digits, only numbers will be stored. |
| phone_number[is_primary] | boolean Is this phone number the care team member's primary contact number. |
| phone_number[phone_type] | string Enum: "mobile" "home" "work" "fax" "unknown" Type of phone number. |
| phone_number[can_sms] | boolean Can this phone number receive SMS? |
| phone_number[country_code] | string Country code for the phone number. Defaults to 1, if not specified. |
{- "phone_number[phone_number]": "string",
- "phone_number[is_primary]": true,
- "phone_number[phone_type]": "mobile",
- "phone_number[can_sms]": true,
- "phone_number[country_code]": "string"
}| id required | string |
| member_id required | string |
| contact_id required | string |
| group_id required | string |
| phone_number[phone_number] required | string The phone number itself. Minimum 7 digits, only numbers will be stored. |
| phone_number[is_primary] | boolean Is this phone number the care team member's primary contact number. |
| phone_number[phone_type] | string Enum: "mobile" "home" "work" "fax" "unknown" Type of phone number. |
| phone_number[can_sms] | boolean Can this phone number receive SMS? |
| phone_number[country_code] | string Country code for the phone number. Defaults to 1, if not specified. |
{- "phone_number[phone_number]": "string",
- "phone_number[is_primary]": true,
- "phone_number[phone_type]": "mobile",
- "phone_number[can_sms]": true,
- "phone_number[country_code]": "string"
}| contact_id required | string |
| group_id required | string |
| program[program_id] required | string The identifier of the Program the contact and case is being enrolled in. |
| service_type_id required | string The identifier of the requested service type (need). |
| assistance_request_id | string The identifier of an assistance request submitted by the Contact. This will connect the originating assistance request to the case. |
| service_case[description] | string The full-text details or description of the case. |
| service_case[primary_worker_id] | string The user ID of the primary case worker. |
| service_case[documents] | Array of strings |
| service_case[out_of_network_providers] | Array of strings |
| primary_data_source | boolean Boolean to disable performance optimization for retrieving service cases. |
| network_id | string The identifier of the Network that is managing the case. |
| program[entry_date] | number Timestamp representing the enrollment date. |
{- "program[program_id]": "string",
- "service_type_id": "string",
- "assistance_request_id": "string",
- "service_case[description]": "string",
- "service_case[primary_worker_id]": "string",
- "service_case[documents]": [
- "string"
], - "service_case[out_of_network_providers]": [
- "string"
], - "primary_data_source": true,
- "network_id": "string",
- "program[entry_date]": 0
}| id required | string |
| contact_id required | string |
| group_id required | string |
| assistance_request_id | string The identifier of an assistance request submitted by the Contact. This will connect the originating assistance request to the case. |
| service_type_id | string The identifier of the requested service type (need). |
| service_case[description] | string The full-text details or description of the case. |
| service_case[primary_worker_id] | string The user ID of the primary case worker. |
| service_case[documents] | Array of strings |
| service_case[out_of_network_providers] | Array of strings |
| primary_data_source | boolean Boolean to disable performance optimization for retrieving service cases. |
| network_id | string The identifier of the Network that is managing the case. |
| program[program_id] | string The identifier of the Program the contact and case is being enrolled in. |
| program[entry_date] | number Timestamp representing the enrollment date. |
{- "assistance_request_id": "string",
- "service_type_id": "string",
- "service_case[description]": "string",
- "service_case[primary_worker_id]": "string",
- "service_case[documents]": [
- "string"
], - "service_case[out_of_network_providers]": [
- "string"
], - "primary_data_source": true,
- "network_id": "string",
- "program[program_id]": "string",
- "program[entry_date]": 0
}| id required | string |
| contact_id required | string |
| group_id required | string |
| assistance_request_id | string The identifier of an assistance request submitted by the Contact. This will connect the originating assistance request to the case. |
| service_type_id | string The identifier of the requested service type (need). |
| service_case[description] | string The full-text details or description of the case. |
| service_case[primary_worker_id] | string The user ID of the primary case worker. |
| service_case[documents] | Array of strings |
| service_case[out_of_network_providers] | Array of strings |
| primary_data_source | boolean Boolean to disable performance optimization for retrieving service cases. |
| network_id | string The identifier of the Network that is managing the case. |
| program[program_id] | string The identifier of the Program the contact and case is being enrolled in. |
| program[entry_date] | number Timestamp representing the enrollment date. |
{- "assistance_request_id": "string",
- "service_type_id": "string",
- "service_case[description]": "string",
- "service_case[primary_worker_id]": "string",
- "service_case[documents]": [
- "string"
], - "service_case[out_of_network_providers]": [
- "string"
], - "primary_data_source": true,
- "network_id": "string",
- "program[program_id]": "string",
- "program[entry_date]": 0
}| service_case_id required | string |
| contact_id required | string |
| group_id required | string |
| page | number The page of results to be returned. |
| per | number The number of records to be returned per page. |
| sord | string Enum: "asc" "desc" The order to sort the results. |
| sidx | string The attribute to sort the results by. |
| id required | string |
| service_case_id required | string |
| contact_id required | string |
| group_id required | string |
| document[title] required | string The name associated with the document |
| attach_to_id | string The ID of the object to change the document attachment to. |
{- "document[title]": "string",
- "attach_to_id": "string"
}| id required | string |
| service_case_id required | string |
| contact_id required | string |
| group_id required | string |
| document[title] required | string The name associated with the document |
| attach_to_id | string The ID of the object to change the document attachment to. |
{- "document[title]": "string",
- "attach_to_id": "string"
}| service_case_id required | string |
| contact_id required | string |
| group_id required | string |
| user_id required | string The ID of the user to be set as the primary case worker. |
{- "user_id": "string"
}| service_case_id required | string |
| contact_id required | string |
| group_id required | string |
| user_id required | string The ID of the user to be set as the primary case worker. |
{- "user_id": "string"
}Confirm 2FA verification code for a Unite US user account.
Takes a confirmation token from the client and verifies that token with
Authy API. A successful confirmation will return a 200 SUCCESS
response to the client.
| user_id required | string |
| token | string The token the user received via SMS. |
{- "token": "string"
}Takes a confirmation token from the client and verifies that token with
Authy API. A successful confirmation will return a 200 SUCCESS
response to the client.
| user_id required | string |
| token | string The token the user received via SMS. |
{- "token": "string"
}| contact_id required | string |
| group_id required | string |
| page | number The page of results to be returned. |
| per | number The number of records to be returned per page. |
| sord | string Enum: "asc" "desc" The order to sort the results. |
| sidx | string The attribute to sort the results by. |
| contact_id required | string |
| group_id required | string |
| member[last_name] required | string Team member's last name. |
| member[first_name] required | string Team member's first name. |
| member[email] | string Team member's email address. |
| member[relation_to_contact] | string Team member's relation to the contact. |
| member[addresses] | Array of strings |
| member[email_addresses] | Array of strings |
| member[phone_numbers] | Array of strings |
{- "member[last_name]": "string",
- "member[first_name]": "string",
- "member[email]": "string",
- "member[relation_to_contact]": "string",
- "member[addresses]": [
- "string"
], - "member[email_addresses]": [
- "string"
], - "member[phone_numbers]": [
- "string"
]
}| id required | string |
| contact_id required | string |
| group_id required | string |
| member[first_name] | string Team member's first name. |
| member[last_name] | string Team member's last name. |
| member[email] | string Team member's email address. |
| member[relation_to_contact] | string Team member's relation to the contact. |
| member[addresses] | Array of strings |
| member[email_addresses] | Array of strings |
| member[phone_numbers] | Array of strings |
{- "member[first_name]": "string",
- "member[last_name]": "string",
- "member[email]": "string",
- "member[relation_to_contact]": "string",
- "member[addresses]": [
- "string"
], - "member[email_addresses]": [
- "string"
], - "member[phone_numbers]": [
- "string"
]
}| id required | string |
| contact_id required | string |
| group_id required | string |
| member[first_name] | string Team member's first name. |
| member[last_name] | string Team member's last name. |
| member[email] | string Team member's email address. |
| member[relation_to_contact] | string Team member's relation to the contact. |
| member[addresses] | Array of strings |
| member[email_addresses] | Array of strings |
| member[phone_numbers] | Array of strings |
{- "member[first_name]": "string",
- "member[last_name]": "string",
- "member[email]": "string",
- "member[relation_to_contact]": "string",
- "member[addresses]": [
- "string"
], - "member[email_addresses]": [
- "string"
], - "member[phone_numbers]": [
- "string"
]
}| group_id required | string |
| page | number The page of results to be returned. |
| per | number The number of records to be returned per page. |
| sord | string Enum: "asc" "desc" The order to sort the results. |
| sidx | string The attribute to sort the results by. |
| group_id required | string |
| contact[last_name] required | string Contact's last name. |
| contact[first_name] required | string Contact's first name. |
| network_id | string The identifier of the Network the contact is participating in. |
| assistance_request_id | string The identifier of an assistance request submitted by the Contact. This will cause the API to attempt to transfer data from the assistance request requestor to the Contact. |
| contact[email] | string Contact's email address. |
| contact[date_of_birth] | number Unix (epoch) timestamp representing the contact's date of birth. |
| contact[gender] | string Enum: "male" "female" "undisclosed" "non-binary" "other" Contact's specified gender. |
| contact[citizenship] | string Enum: "us-citizen" "us-national" "lawful-permanent-resident" "other" "undisclosed" Contact's specified citizenship. |
| contact[ethnicity] | string Enum: "hispanic-or-latino" "not-hispanic-or-latino" "undisclosed" Contact's specified ethnicity. |
| contact[marital_status] | string Enum: "divorced" "domestic_partner" "married-civil-union" "single/never-married" "separated" "undisclosed" "widowed" Contact's specified marital status. |
| contact[race] | string Enum: "american-indian-alaska-native" "asian" "black-african-american" "native-hawaiian-or-pacific-islander" "other-race" "undisclosed" "white" Contact's specified race. |
| contact[email_address] | string Contact's primary email address. |
| contact[preferred_first_name] | string Contact's preferred first name. |
| contact[title] | string Enum: "Mr." "Miss" "Mrs." "Ms." "Dr." Contact's title. |
| contact[middle_name_initial] | string Contact's middle name or initial. |
| contact[suffix] | string Enum: "Jr." "Sr." "III" "IV" "V" "Esq." "Ph.D" Contact's suffix. |
| contact[nicknames] | Array of strings Contact's nicknames. |
| contact[preferred_communication_method] | string Enum: "phone_call" "sms" "email" "no_preference" Preferred communication method |
| contact[preferred_communication_time_of_day] | string Enum: "any_time" "morning" "afternoon" "evening" Preferred communication time of day |
| contact[addresses] | Array of strings |
| contact[email_addresses] | Array of strings |
| contact[phone_numbers] | Array of strings |
| contact[military][affiliation] | string Enum: "military_member_or_veteran" "spouse" "widow" "family_member" "caregiver" "prefer_not_to_disclose" Military affiliation |
| contact[military][current_status] | string Enum: "active_duty" "national_guard" "reserve" "retiree" "veteran" "prefer_not_to_disclose" Current military status |
| contact[military][currently_transitioning] | string Enum: "yes_12mos_before" "yes_12mos_after" "no" "prefer_not_to_disclose" Is the contact currently transitioning? |
| contact[military][at_least_one_day_active_duty] | string Enum: "yes" "no" "prefer_not_to_disclose" Has at least one day of active duty outside of basic training? |
| contact[military][branch] | string Enum: "air_force" "army" "coast_guard" "marines" "navy" "prefer_not_to_disclose" Branch of service |
| contact[military][service_era] | string Enum: "post_911" "persian_gulf" "post_vietnam" "vietnam" "post_korean" "korean_war" "pre_korean" "ww2" "merchant_marine" "ww1" "prefer_not_to_disclose" Service era |
| contact[military][entry_date] | number Date of entry |
| contact[military][exit_date] | number Date of exit |
| contact[military][deployed] | string Enum: "yes" "no" "prefer_not_to_disclose" Deployed? |
| contact[military][deployment_starts_at] | number Deployment start date |
| contact[military][deployment_ends_at] | number Deployment end date |
| contact[military][discharge_type] | string Enum: "honorable" "general" "other_than_honorable" "bad_conduct" "dishonorable" "uncharacterized" "other" "prefer_not_to_disclose" Discharge type |
| contact[military][discharged_due_to_disability] | string Enum: "yes" "no" "prefer_not_to_disclose" Discharged or retired from military service for a disability incurred in the line of duty? |
| contact[military][service_connected_disability] | string Enum: "yes" "no" "prefer_not_to_disclose" Has VA-rated Service-Connected Disability? |
| contact[military][service_connected_disability_rating] | string Enum: "0" "10" "20" "30" "40" "50" "60" "70" "80" "90" "100" "prefer_not_to_disclose" Service-Connected Disability Rating |
| contact[military][proof_of_veteran_status] | string Enum: "yes" "no" "prefer_not_to_disclose" Have proof of veteran status? |
| contact[military][proof_type] | string Enum: "dd214" "va_id" "statement_of_service" "retiree_id" "drivers_license" "military_id" "other" "prefer_not_to_disclose" Proof type |
| contact[insurance_ids] | Array of strings |
{- "contact[last_name]": "string",
- "contact[first_name]": "string",
- "network_id": "string",
- "assistance_request_id": "string",
- "contact[email]": "string",
- "contact[date_of_birth]": 0,
- "contact[gender]": "male",
- "contact[citizenship]": "us-citizen",
- "contact[ethnicity]": "hispanic-or-latino",
- "contact[marital_status]": "divorced",
- "contact[race]": "american-indian-alaska-native",
- "contact[email_address]": "string",
- "contact[preferred_first_name]": "string",
- "contact[title]": "Mr.",
- "contact[middle_name_initial]": "string",
- "contact[suffix]": "Jr.",
- "contact[nicknames]": [
- "string"
], - "contact[preferred_communication_method]": "phone_call",
- "contact[preferred_communication_time_of_day]": "any_time",
- "contact[addresses]": [
- "string"
], - "contact[email_addresses]": [
- "string"
], - "contact[phone_numbers]": [
- "string"
], - "contact[military][affiliation]": "military_member_or_veteran",
- "contact[military][current_status]": "active_duty",
- "contact[military][currently_transitioning]": "yes_12mos_before",
- "contact[military][at_least_one_day_active_duty]": "yes",
- "contact[military][branch]": "air_force",
- "contact[military][service_era]": "post_911",
- "contact[military][entry_date]": 0,
- "contact[military][exit_date]": 0,
- "contact[military][deployed]": "yes",
- "contact[military][deployment_starts_at]": 0,
- "contact[military][deployment_ends_at]": 0,
- "contact[military][discharge_type]": "honorable",
- "contact[military][discharged_due_to_disability]": "yes",
- "contact[military][service_connected_disability]": "yes",
- "contact[military][service_connected_disability_rating]": "0",
- "contact[military][proof_of_veteran_status]": "yes",
- "contact[military][proof_type]": "dd214",
- "contact[insurance_ids]": [
- "string"
]
}| id required | string |
| group_id required | string |
| network_id | string The identifier of the Network the contact is participating in. |
| assistance_request_id | string The identifier of an assistance request submitted by the Contact. This will cause the API to attempt to transfer data from the assistance request requestor to the Contact. |
| contact[first_name] | string Contact's first name. |
| contact[last_name] | string Contact's last name. |
| contact[email] | string Contact's email address. |
| contact[date_of_birth] | number Unix (epoch) timestamp representing the contact's date of birth. |
| contact[gender] | string Enum: "male" "female" "undisclosed" "non-binary" "other" Contact's specified gender. |
| contact[citizenship] | string Enum: "us-citizen" "us-national" "lawful-permanent-resident" "other" "undisclosed" Contact's specified citizenship. |
| contact[ethnicity] | string Enum: "hispanic-or-latino" "not-hispanic-or-latino" "undisclosed" Contact's specified ethnicity. |
| contact[marital_status] | string Enum: "divorced" "domestic_partner" "married-civil-union" "single/never-married" "separated" "undisclosed" "widowed" Contact's specified marital status. |
| contact[race] | string Enum: "american-indian-alaska-native" "asian" "black-african-american" "native-hawaiian-or-pacific-islander" "other-race" "undisclosed" "white" Contact's specified race. |
| contact[email_address] | string Contact's primary email address. |
| contact[preferred_first_name] | string Contact's preferred first name. |
| contact[title] | string Enum: "Mr." "Miss" "Mrs." "Ms." "Dr." Contact's title. |
| contact[middle_name_initial] | string Contact's middle name or initial. |
| contact[suffix] | string Enum: "Jr." "Sr." "III" "IV" "V" "Esq." "Ph.D" Contact's suffix. |
| contact[nicknames] | Array of strings Contact's nicknames. |
| contact[preferred_communication_method] | string Enum: "phone_call" "sms" "email" "no_preference" Preferred communication method |
| contact[preferred_communication_time_of_day] | string Enum: "any_time" "morning" "afternoon" "evening" Preferred communication time of day |
| contact[addresses] | Array of strings |
| contact[email_addresses] | Array of strings |
| contact[phone_numbers] | Array of strings |
| contact[military][affiliation] | string Enum: "military_member_or_veteran" "spouse" "widow" "family_member" "caregiver" "prefer_not_to_disclose" Military affiliation |
| contact[military][current_status] | string Enum: "active_duty" "national_guard" "reserve" "retiree" "veteran" "prefer_not_to_disclose" Current military status |
| contact[military][currently_transitioning] | string Enum: "yes_12mos_before" "yes_12mos_after" "no" "prefer_not_to_disclose" Is the contact currently transitioning? |
| contact[military][at_least_one_day_active_duty] | string Enum: "yes" "no" "prefer_not_to_disclose" Has at least one day of active duty outside of basic training? |
| contact[military][branch] | string Enum: "air_force" "army" "coast_guard" "marines" "navy" "prefer_not_to_disclose" Branch of service |
| contact[military][service_era] | string Enum: "post_911" "persian_gulf" "post_vietnam" "vietnam" "post_korean" "korean_war" "pre_korean" "ww2" "merchant_marine" "ww1" "prefer_not_to_disclose" Service era |
| contact[military][entry_date] | number Date of entry |
| contact[military][exit_date] | number Date of exit |
| contact[military][deployed] | string Enum: "yes" "no" "prefer_not_to_disclose" Deployed? |
| contact[military][deployment_starts_at] | number Deployment start date |
| contact[military][deployment_ends_at] | number Deployment end date |
| contact[military][discharge_type] | string Enum: "honorable" "general" "other_than_honorable" "bad_conduct" "dishonorable" "uncharacterized" "other" "prefer_not_to_disclose" Discharge type |
| contact[military][discharged_due_to_disability] | string Enum: "yes" "no" "prefer_not_to_disclose" Discharged or retired from military service for a disability incurred in the line of duty? |
| contact[military][service_connected_disability] | string Enum: "yes" "no" "prefer_not_to_disclose" Has VA-rated Service-Connected Disability? |
| contact[military][service_connected_disability_rating] | string Enum: "0" "10" "20" "30" "40" "50" "60" "70" "80" "90" "100" "prefer_not_to_disclose" Service-Connected Disability Rating |
| contact[military][proof_of_veteran_status] | string Enum: "yes" "no" "prefer_not_to_disclose" Have proof of veteran status? |
| contact[military][proof_type] | string Enum: "dd214" "va_id" "statement_of_service" "retiree_id" "drivers_license" "military_id" "other" "prefer_not_to_disclose" Proof type |
| contact[insurance_ids] | Array of strings |
{- "network_id": "string",
- "assistance_request_id": "string",
- "contact[first_name]": "string",
- "contact[last_name]": "string",
- "contact[email]": "string",
- "contact[date_of_birth]": 0,
- "contact[gender]": "male",
- "contact[citizenship]": "us-citizen",
- "contact[ethnicity]": "hispanic-or-latino",
- "contact[marital_status]": "divorced",
- "contact[race]": "american-indian-alaska-native",
- "contact[email_address]": "string",
- "contact[preferred_first_name]": "string",
- "contact[title]": "Mr.",
- "contact[middle_name_initial]": "string",
- "contact[suffix]": "Jr.",
- "contact[nicknames]": [
- "string"
], - "contact[preferred_communication_method]": "phone_call",
- "contact[preferred_communication_time_of_day]": "any_time",
- "contact[addresses]": [
- "string"
], - "contact[email_addresses]": [
- "string"
], - "contact[phone_numbers]": [
- "string"
], - "contact[military][affiliation]": "military_member_or_veteran",
- "contact[military][current_status]": "active_duty",
- "contact[military][currently_transitioning]": "yes_12mos_before",
- "contact[military][at_least_one_day_active_duty]": "yes",
- "contact[military][branch]": "air_force",
- "contact[military][service_era]": "post_911",
- "contact[military][entry_date]": 0,
- "contact[military][exit_date]": 0,
- "contact[military][deployed]": "yes",
- "contact[military][deployment_starts_at]": 0,
- "contact[military][deployment_ends_at]": 0,
- "contact[military][discharge_type]": "honorable",
- "contact[military][discharged_due_to_disability]": "yes",
- "contact[military][service_connected_disability]": "yes",
- "contact[military][service_connected_disability_rating]": "0",
- "contact[military][proof_of_veteran_status]": "yes",
- "contact[military][proof_type]": "dd214",
- "contact[insurance_ids]": [
- "string"
]
}| id required | string |
| group_id required | string |
| network_id | string The identifier of the Network the contact is participating in. |
| assistance_request_id | string The identifier of an assistance request submitted by the Contact. This will cause the API to attempt to transfer data from the assistance request requestor to the Contact. |
| contact[first_name] | string Contact's first name. |
| contact[last_name] | string Contact's last name. |
| contact[email] | string Contact's email address. |
| contact[date_of_birth] | number Unix (epoch) timestamp representing the contact's date of birth. |
| contact[gender] | string Enum: "male" "female" "undisclosed" "non-binary" "other" Contact's specified gender. |
| contact[citizenship] | string Enum: "us-citizen" "us-national" "lawful-permanent-resident" "other" "undisclosed" Contact's specified citizenship. |
| contact[ethnicity] | string Enum: "hispanic-or-latino" "not-hispanic-or-latino" "undisclosed" Contact's specified ethnicity. |
| contact[marital_status] | string Enum: "divorced" "domestic_partner" "married-civil-union" "single/never-married" "separated" "undisclosed" "widowed" Contact's specified marital status. |
| contact[race] | string Enum: "american-indian-alaska-native" "asian" "black-african-american" "native-hawaiian-or-pacific-islander" "other-race" "undisclosed" "white" Contact's specified race. |
| contact[email_address] | string Contact's primary email address. |
| contact[preferred_first_name] | string Contact's preferred first name. |
| contact[title] | string Enum: "Mr." "Miss" "Mrs." "Ms." "Dr." Contact's title. |
| contact[middle_name_initial] | string Contact's middle name or initial. |
| contact[suffix] | string Enum: "Jr." "Sr." "III" "IV" "V" "Esq." "Ph.D" Contact's suffix. |
| contact[nicknames] | Array of strings Contact's nicknames. |
| contact[preferred_communication_method] | string Enum: "phone_call" "sms" "email" "no_preference" Preferred communication method |
| contact[preferred_communication_time_of_day] | string Enum: "any_time" "morning" "afternoon" "evening" Preferred communication time of day |
| contact[addresses] | Array of strings |
| contact[email_addresses] | Array of strings |
| contact[phone_numbers] | Array of strings |
| contact[military][affiliation] | string Enum: "military_member_or_veteran" "spouse" "widow" "family_member" "caregiver" "prefer_not_to_disclose" Military affiliation |
| contact[military][current_status] | string Enum: "active_duty" "national_guard" "reserve" "retiree" "veteran" "prefer_not_to_disclose" Current military status |
| contact[military][currently_transitioning] | string Enum: "yes_12mos_before" "yes_12mos_after" "no" "prefer_not_to_disclose" Is the contact currently transitioning? |
| contact[military][at_least_one_day_active_duty] | string Enum: "yes" "no" "prefer_not_to_disclose" Has at least one day of active duty outside of basic training? |
| contact[military][branch] | string Enum: "air_force" "army" "coast_guard" "marines" "navy" "prefer_not_to_disclose" Branch of service |
| contact[military][service_era] | string Enum: "post_911" "persian_gulf" "post_vietnam" "vietnam" "post_korean" "korean_war" "pre_korean" "ww2" "merchant_marine" "ww1" "prefer_not_to_disclose" Service era |
| contact[military][entry_date] | number Date of entry |
| contact[military][exit_date] | number Date of exit |
| contact[military][deployed] | string Enum: "yes" "no" "prefer_not_to_disclose" Deployed? |
| contact[military][deployment_starts_at] | number Deployment start date |
| contact[military][deployment_ends_at] | number Deployment end date |
| contact[military][discharge_type] | string Enum: "honorable" "general" "other_than_honorable" "bad_conduct" "dishonorable" "uncharacterized" "other" "prefer_not_to_disclose" Discharge type |
| contact[military][discharged_due_to_disability] | string Enum: "yes" "no" "prefer_not_to_disclose" Discharged or retired from military service for a disability incurred in the line of duty? |
| contact[military][service_connected_disability] | string Enum: "yes" "no" "prefer_not_to_disclose" Has VA-rated Service-Connected Disability? |
| contact[military][service_connected_disability_rating] | string Enum: "0" "10" "20" "30" "40" "50" "60" "70" "80" "90" "100" "prefer_not_to_disclose" Service-Connected Disability Rating |
| contact[military][proof_of_veteran_status] | string Enum: "yes" "no" "prefer_not_to_disclose" Have proof of veteran status? |
| contact[military][proof_type] | string Enum: "dd214" "va_id" "statement_of_service" "retiree_id" "drivers_license" "military_id" "other" "prefer_not_to_disclose" Proof type |
| contact[insurance_ids] | Array of strings |
{- "network_id": "string",
- "assistance_request_id": "string",
- "contact[first_name]": "string",
- "contact[last_name]": "string",
- "contact[email]": "string",
- "contact[date_of_birth]": 0,
- "contact[gender]": "male",
- "contact[citizenship]": "us-citizen",
- "contact[ethnicity]": "hispanic-or-latino",
- "contact[marital_status]": "divorced",
- "contact[race]": "american-indian-alaska-native",
- "contact[email_address]": "string",
- "contact[preferred_first_name]": "string",
- "contact[title]": "Mr.",
- "contact[middle_name_initial]": "string",
- "contact[suffix]": "Jr.",
- "contact[nicknames]": [
- "string"
], - "contact[preferred_communication_method]": "phone_call",
- "contact[preferred_communication_time_of_day]": "any_time",
- "contact[addresses]": [
- "string"
], - "contact[email_addresses]": [
- "string"
], - "contact[phone_numbers]": [
- "string"
], - "contact[military][affiliation]": "military_member_or_veteran",
- "contact[military][current_status]": "active_duty",
- "contact[military][currently_transitioning]": "yes_12mos_before",
- "contact[military][at_least_one_day_active_duty]": "yes",
- "contact[military][branch]": "air_force",
- "contact[military][service_era]": "post_911",
- "contact[military][entry_date]": 0,
- "contact[military][exit_date]": 0,
- "contact[military][deployed]": "yes",
- "contact[military][deployment_starts_at]": 0,
- "contact[military][deployment_ends_at]": 0,
- "contact[military][discharge_type]": "honorable",
- "contact[military][discharged_due_to_disability]": "yes",
- "contact[military][service_connected_disability]": "yes",
- "contact[military][service_connected_disability_rating]": "0",
- "contact[military][proof_of_veteran_status]": "yes",
- "contact[military][proof_type]": "dd214",
- "contact[insurance_ids]": [
- "string"
]
}| group_id required | string |
| page | number The page of results to be returned. |
| per | number The number of records to be returned per page. |
| sord | string Enum: "asc" "desc" The order to sort the results. |
| sidx | string The attribute to sort the results by. |
| contact_id required | string |
| group_id required | string |
| address[state] required | string State or province for the address. |
| address[postal_code] required | string Postal or ZIP code for the address. Minimum 5 characters in length, maximum 15. |
| address[city] required | string City or town of the address. |
| address[address_type] required | string Enum: "home" "mailing" "work" "unknown" Type of address. |
| address[line_1] | string Address line 1 |
| address[line_2] | string Additional address details, ex. apartment, suite, etc. |
| address[country] | string Country for the address. |
| address[is_mailing_address] | boolean Is this a mailing address. |
{- "address[state]": "string",
- "address[postal_code]": "string",
- "address[city]": "string",
- "address[address_type]": "home",
- "address[line_1]": "string",
- "address[line_2]": "string",
- "address[country]": "string",
- "address[is_mailing_address]": true
}| id required | string |
| contact_id required | string |
| group_id required | string |
| address[state] required | string State or province for the address. |
| address[postal_code] required | string Postal or ZIP code for the address. Minimum 5 characters in length, maximum 15. |
| address[city] required | string City or town of the address. |
| address[address_type] required | string Enum: "home" "mailing" "work" "unknown" Type of address. |
| address[line_1] | string Address line 1 |
| address[line_2] | string Additional address details, ex. apartment, suite, etc. |
| address[country] | string Country for the address. |
| address[is_mailing_address] | boolean Is this a mailing address. |
{- "address[state]": "string",
- "address[postal_code]": "string",
- "address[city]": "string",
- "address[address_type]": "home",
- "address[line_1]": "string",
- "address[line_2]": "string",
- "address[country]": "string",
- "address[is_mailing_address]": true
}| id required | string |
| contact_id required | string |
| group_id required | string |
| address[state] required | string State or province for the address. |
| address[postal_code] required | string Postal or ZIP code for the address. Minimum 5 characters in length, maximum 15. |
| address[city] required | string City or town of the address. |
| address[address_type] required | string Enum: "home" "mailing" "work" "unknown" Type of address. |
| address[line_1] | string Address line 1 |
| address[line_2] | string Additional address details, ex. apartment, suite, etc. |
| address[country] | string Country for the address. |
| address[is_mailing_address] | boolean Is this a mailing address. |
{- "address[state]": "string",
- "address[postal_code]": "string",
- "address[city]": "string",
- "address[address_type]": "home",
- "address[line_1]": "string",
- "address[line_2]": "string",
- "address[country]": "string",
- "address[is_mailing_address]": true
}| contact_id required | string |
| group_id required | string |
| consents[email_address] required | string Email you would like to deliver the consent request to. |
{- "consents[email_address]": "string"
}| contact_id required | string |
| group_id required | string |
| consents[phone_number] required | string Phone number to deliver the consent request to. |
{- "consents[phone_number]": "string"
}| contact_id required | string |
| group_id required | string |
| consents[documents] | Array of strings |
{- "consents[documents]": [
- "string"
]
}| contact_id required | string |
| group_id required | string |
| page | number The page of results to be returned. |
| per | number The number of records to be returned per page. |
| sord | string Enum: "asc" "desc" The order to sort the results. |
| sidx | string The attribute to sort the results by. |
| id required | string |
| contact_id required | string |
| group_id required | string |
| document[title] required | string The name associated with the document |
| attach_to_id | string The ID of the object to change the document attachment to. |
{- "document[title]": "string",
- "attach_to_id": "string"
}| id required | string |
| contact_id required | string |
| group_id required | string |
| document[title] required | string The name associated with the document |
| attach_to_id | string The ID of the object to change the document attachment to. |
{- "document[title]": "string",
- "attach_to_id": "string"
}| contact_id required | string |
| group_id required | string |
| email_address[email_address] required | string A valid email address |
| email_address[is_primary] | boolean Is this email address the primary one for the contact. |
| email_address[acceptable_communication_types] | string Enum: "message" "notification" Acceptable methods by which to contact the user at this email |
{- "email_address[email_address]": "string",
- "email_address[is_primary]": true,
- "email_address[acceptable_communication_types]": "message"
}| id required | string |
| contact_id required | string |
| group_id required | string |
| email_address[email_address] required | string A valid email address |
| email_address[is_primary] | boolean Is this email address the primary one for the contact. |
| email_address[acceptable_communication_types] | string Enum: "message" "notification" Acceptable methods by which to contact the user at this email |
{- "email_address[email_address]": "string",
- "email_address[is_primary]": true,
- "email_address[acceptable_communication_types]": "message"
}| id required | string |
| contact_id required | string |
| group_id required | string |
| email_address[email_address] required | string A valid email address |
| email_address[is_primary] | boolean Is this email address the primary one for the contact. |
| email_address[acceptable_communication_types] | string Enum: "message" "notification" Acceptable methods by which to contact the user at this email |
{- "email_address[email_address]": "string",
- "email_address[is_primary]": true,
- "email_address[acceptable_communication_types]": "message"
}Filtered activity stream or timeline events are returned loosely based on the Activity Stream specification (activitystrea.ms).
Available verb values include: accept,
add, assign, close,
complete, create, delete,
deny, join, leave,
open, post, replace,
retract, save, send, and
update.
Use the verb, object, and target values to determine the event that occurred.
| contact_id required | string |
| group_id required | string |
| q[filter_names] | string Enum: "client_updates" "closed_records" "notes" "record_updates" "network_updates" "care_team" Name of filter to be appliied |
| page | number The page of results to be returned. |
| per | number The number of records to be returned per page. |
| sord | string Enum: "asc" "desc" The order to sort the results. |
| sidx | string The attribute to sort the results by. |
{- "q[filter_names]": "client_updates",
- "page": 0,
- "per": 0,
- "sord": "asc",
- "sidx": "string"
}| group_id required | string |
| page | number The page of results to be returned. |
| per | number The number of records to be returned per page. |
| sord | string Enum: "asc" "desc" The order to sort the results. |
| sidx | string The attribute to sort the results by. |
| user_id required | string |
| group_id required | string |
| page | number The page of results to be returned. |
| per | number The number of records to be returned per page. |
| sord | string Enum: "asc" "desc" The order to sort the results. |
| sidx | string The attribute to sort the results by. |
| contact_id required | string |
| group_id required | string |
| collection_class_id | string |
| interaction[note] | string Information about the interaction |
{- "collection_class_id": "string",
- "interaction[note]": "string"
}| id required | string |
| contact_id required | string |
| group_id required | string |
| collection_class_id | string |
| interaction[note] | string Information about the interaction |
{- "collection_class_id": "string",
- "interaction[note]": "string"
}| id required | string |
| contact_id required | string |
| group_id required | string |
| collection_class_id | string |
| interaction[note] | string Information about the interaction |
{- "collection_class_id": "string",
- "interaction[note]": "string"
}| contact_id required | string |
| group_id required | string |
| phone_number[phone_number] required | string The phone number itself. Minimum 7 digits, only numbers will be stored. |
| phone_number[is_primary] | boolean Is this phone number the contact's primary contact number. |
| phone_number[phone_type] | string Enum: "mobile" "home" "work" "fax" "unknown" Type of phone number. |
| phone_number[can_sms] | boolean Can this phone number receive SMS? |
| phone_number[country_code] | string Country code for the phone number. Defaults to 1, if not specified. |
| phone_number[acceptable_communication_types] | string Enum: "phone_call" "message" "notification" Acceptable methods by which to contact the user at this email |
{- "phone_number[phone_number]": "string",
- "phone_number[is_primary]": true,
- "phone_number[phone_type]": "mobile",
- "phone_number[can_sms]": true,
- "phone_number[country_code]": "string",
- "phone_number[acceptable_communication_types]": "phone_call"
}| id required | string |
| contact_id required | string |
| group_id required | string |
| phone_number[phone_number] required | string The phone number itself. Minimum 7 digits, only numbers will be stored. |
| phone_number[is_primary] | boolean Is this phone number the contact's primary contact number. |
| phone_number[phone_type] | string Enum: "mobile" "home" "work" "fax" "unknown" Type of phone number. |
| phone_number[can_sms] | boolean Can this phone number receive SMS? |
| phone_number[country_code] | string Country code for the phone number. Defaults to 1, if not specified. |
| phone_number[acceptable_communication_types] | string Enum: "phone_call" "message" "notification" Acceptable methods by which to contact the user at this email |
{- "phone_number[phone_number]": "string",
- "phone_number[is_primary]": true,
- "phone_number[phone_type]": "mobile",
- "phone_number[can_sms]": true,
- "phone_number[country_code]": "string",
- "phone_number[acceptable_communication_types]": "phone_call"
}| id required | string |
| contact_id required | string |
| group_id required | string |
| phone_number[phone_number] required | string The phone number itself. Minimum 7 digits, only numbers will be stored. |
| phone_number[is_primary] | boolean Is this phone number the contact's primary contact number. |
| phone_number[phone_type] | string Enum: "mobile" "home" "work" "fax" "unknown" Type of phone number. |
| phone_number[can_sms] | boolean Can this phone number receive SMS? |
| phone_number[country_code] | string Country code for the phone number. Defaults to 1, if not specified. |
| phone_number[acceptable_communication_types] | string Enum: "phone_call" "message" "notification" Acceptable methods by which to contact the user at this email |
{- "phone_number[phone_number]": "string",
- "phone_number[is_primary]": true,
- "phone_number[phone_type]": "mobile",
- "phone_number[can_sms]": true,
- "phone_number[country_code]": "string",
- "phone_number[acceptable_communication_types]": "phone_call"
}| contact_id required | string |
| group_id required | string |
| page | number The page of results to be returned. |
| per | number The number of records to be returned per page. |
| sord | string Enum: "asc" "desc" The order to sort the results. |
| sidx | string The attribute to sort the results by. |
| contact_id required | string |
| group_id required | string |
| assistance_request_id | string The identifier of an assistance request submitted by the Contact. This will connect the originating assistance request to the referral. |
| referrals | Array of strings |
{- "assistance_request_id": "string",
- "referrals": [
- "string"
]
}| contact_id required | string |
| group_id required | string |
| assistance_request_id | string The identifier of an assistance request submitted by the Contact. This will connect the originating assistance request to the referral. |
| referrals | Array of strings |
{- "assistance_request_id": "string",
- "referrals": [
- "string"
]
}| id required | string |
| contact_id required | string |
| group_id required | string |
| assistance_request_id | string The identifier of an assistance request submitted by the Contact. This will connect the originating assistance request to the referral. |
| referrals | Array of strings |
{- "assistance_request_id": "string",
- "referrals": [
- "string"
]
}| id required | string |
| contact_id required | string |
| group_id required | string |
| assistance_request_id | string The identifier of an assistance request submitted by the Contact. This will connect the originating assistance request to the referral. |
| referrals | Array of strings |
{- "assistance_request_id": "string",
- "referrals": [
- "string"
]
}| form_id required | string |
| contact_id required | string |
| group_id required | string |
| data | Array of strings |
{- "data": [
- "string"
]
}| form_id required | string |
| contact_id required | string |
| group_id required | string |
| data | Array of strings |
{- "data": [
- "string"
]
}| contact_id required | string |
| group_id required | string |
| assistance_request_id | string The identifier of an assistance request submitted by the Contact. This will cause the API to attempt to transfer data from the assistance request requestor to the Contact. |
{- "assistance_request_id": "string"
}| contact_id required | string |
| group_id required | string |
| assistance_request_id | string The identifier of an assistance request submitted by the Contact. This will cause the API to attempt to transfer data from the assistance request requestor to the Contact. |
{- "assistance_request_id": "string"
}Activity Stream or Timeline events are returned loosely based on the Activity Stream specification (activitystrea.ms).
Available verb values include: accept,
add, assign, close,
complete, create, delete,
deny, join, leave,
open, post, replace,
retract, save, send, and
update.
Use the verb, object, and target values to determine the event that occurred.
| contact_id required | string |
| group_id required | string |
| page | number The page of results to be returned. |
| per | number The number of records to be returned per page. |
| sord | string Enum: "asc" "desc" The order to sort the results. |
| sidx | string The attribute to sort the results by. |
| contact_id required | string |
| group_id required | string |
| resource_ids required | Array of strings The ids of the resources from which the document will be removed |
| document_id required | string The id of the document to remove |
{- "resource_ids": [
- "string"
], - "document_id": "string"
}| contact_id required | string |
| group_id required | string |
| options[attach_to_contact] | boolean A boolean specifying whether to attach documents to the contact |
| options[resource_ids] | Array of strings An array of ids for cases, referrals, intakes for a contact |
| document_ids | Array of strings The ids of existing documents |
{- "options[attach_to_contact]": true,
- "options[resource_ids]": [
- "string"
], - "document_ids": [
- "string"
]
}| referral_id required | string |
| group_id required | string |
| options[attach_to_contact] | boolean A boolean specifying whether to attach documents to the contact |
| options[resource_ids] | Array of strings An array of ids for cases, referrals, intakes for a contact |
| document_ids | Array of strings The ids of existing documents |
{- "options[attach_to_contact]": true,
- "options[resource_ids]": [
- "string"
], - "document_ids": [
- "string"
]
}| group_id required | string |
| export[send_email] required | boolean Should send email? |
| export[time_field] required | string Enum: "created_at" "updated_at" "created_or_updated" To which timestamp field should export apply the time constraint |
| export[type] required | string Enum: "assessment" "contact" "interaction" "referral" "service_case" "service_episode_raw" "service_episode_snapshot" "user" Type of export that should be created |
| export[target_type] required | string Enum: "network" "provider" Type of target that is being provided |
| export[target_ids] | Array of strings Array of IDs that identify the targets of the export (ie: Group or Network IDs) |
| export[start_at] | string Earliest date for export (yyyy-mm-dd) |
| export[end_at] | string Ending date for export (yyyy-mm-dd) |
{- "export[send_email]": true,
- "export[time_field]": "created_at",
- "export[type]": "assessment",
- "export[target_type]": "network",
- "export[target_ids]": [
- "string"
], - "export[start_at]": "string",
- "export[end_at]": "string"
}| id required | string |
| new_case | boolean new case |
| case_status_change | boolean case status changed |
| referral_made | boolean referral made |
| referral_declined | boolean referral declined |
| referral_or_case_assigned | boolean referral or case assigned |
| contact_updated | boolean contact updated |
| contact_new_note | boolean contact new note added |
| contact_case_updated | boolean contact case updated |
| contact_case_new_note | boolean contact case new note |
| contact_case_new_document | boolean contact case new document |
| contact_assessment_updated | boolean contact assessement updated |
| care_team_member_added | boolean care team member added |
| care_team_member_updated | boolean care team member updated |
| care_team_member_removed | boolean care team member removed |
| primary_worker_assigned_to_case | boolean primary worked assigned to case |
| accepted_informed_consent | boolean accepted informed consent |
| declined_informed_consent | boolean declined informed consent |
| care_coordinator_assigned | boolean care coordinator assigned |
| id required | string |
| new_case | boolean new case |
| case_status_change | boolean case status changed |
| referral_made | boolean referral made |
| referral_declined | boolean referral declined |
| referral_or_case_assigned | boolean referral or case assigned |
| contact_updated | boolean contact updated |
| contact_new_note | boolean contact new note added |
| contact_case_updated | boolean contact case updated |
| contact_case_new_note | boolean contact case new note |
| contact_case_new_document | boolean contact case new document |
| contact_assessment_updated | boolean contact assessement updated |
| care_team_member_added | boolean care team member added |
| care_team_member_updated | boolean care team member updated |
| care_team_member_removed | boolean care team member removed |
| primary_worker_assigned_to_case | boolean primary worked assigned to case |
| accepted_informed_consent | boolean accepted informed consent |
| declined_informed_consent | boolean declined informed consent |
| care_coordinator_assigned | boolean care coordinator assigned |
{- "new_case": true,
- "case_status_change": true,
- "referral_made": true,
- "referral_declined": true,
- "referral_or_case_assigned": true,
- "contact_updated": true,
- "contact_new_note": true,
- "contact_case_updated": true,
- "contact_case_new_note": true,
- "contact_case_new_document": true,
- "contact_assessment_updated": true,
- "care_team_member_added": true,
- "care_team_member_updated": true,
- "care_team_member_removed": true,
- "primary_worker_assigned_to_case": true,
- "accepted_informed_consent": true,
- "declined_informed_consent": true,
- "care_coordinator_assigned": true
}| id required | string |
| new_case | boolean new case |
| case_status_change | boolean case status changed |
| referral_made | boolean referral made |
| referral_declined | boolean referral declined |
| referral_or_case_assigned | boolean referral or case assigned |
| contact_updated | boolean contact updated |
| contact_new_note | boolean contact new note added |
| contact_case_updated | boolean contact case updated |
| contact_case_new_note | boolean contact case new note |
| contact_case_new_document | boolean contact case new document |
| contact_assessment_updated | boolean contact assessement updated |
| care_team_member_added | boolean care team member added |
| care_team_member_updated | boolean care team member updated |
| care_team_member_removed | boolean care team member removed |
| primary_worker_assigned_to_case | boolean primary worked assigned to case |
| accepted_informed_consent | boolean accepted informed consent |
| declined_informed_consent | boolean declined informed consent |
| care_coordinator_assigned | boolean care coordinator assigned |
{- "new_case": true,
- "case_status_change": true,
- "referral_made": true,
- "referral_declined": true,
- "referral_or_case_assigned": true,
- "contact_updated": true,
- "contact_new_note": true,
- "contact_case_updated": true,
- "contact_case_new_note": true,
- "contact_case_new_document": true,
- "contact_assessment_updated": true,
- "care_team_member_added": true,
- "care_team_member_updated": true,
- "care_team_member_removed": true,
- "primary_worker_assigned_to_case": true,
- "accepted_informed_consent": true,
- "declined_informed_consent": true,
- "care_coordinator_assigned": true
}| id required | string |
| email_updates_enabled | boolean Global email on/off settings |
| update_when_someone_mentions_me | string Enum: "off" "email_only" Methods to alert the user |
{- "email_updates_enabled": true,
- "update_when_someone_mentions_me": "off"
}| id required | string |
| email_updates_enabled | boolean Global email on/off settings |
| update_when_someone_mentions_me | string Enum: "off" "email_only" Methods to alert the user |
{- "email_updates_enabled": true,
- "update_when_someone_mentions_me": "off"
}| service_case_id required | string |
| contact_id required | string |
| group_id required | string |
| enrollment[referred_to] | string Freeform text for information about where the client was referred |
| enrollment[enrolled_at] | number Timestamp representing the enrollment date. |
| enrollment[exited_at] | number Timestamp representing the exit date. |
{- "enrollment[referred_to]": "string",
- "enrollment[enrolled_at]": 0,
- "enrollment[exited_at]": 0
}| service_case_id required | string |
| contact_id required | string |
| group_id required | string |
| enrollment[referred_to] | string Freeform text for information about where the client was referred |
| enrollment[enrolled_at] | number Timestamp representing the enrollment date. |
| enrollment[exited_at] | number Timestamp representing the exit date. |
{- "enrollment[referred_to]": "string",
- "enrollment[enrolled_at]": 0,
- "enrollment[exited_at]": 0
}| id required | string |
| group[consent_enabled] required | boolean Is consent enabled for this organization? |
| group[name] | string The name of the group. |
| group[description] | string Description of the group |
| group[founded_year] | number The year the group was founded. |
| group[logo_data_uri] | string Base64 encoded string of the image to be used for the organization logo. |
| group[org_schedule] | Array of strings The hours of operation for the organization. |
{- "group[consent_enabled]": true,
- "group[name]": "string",
- "group[description]": "string",
- "group[founded_year]": 0,
- "group[logo_data_uri]": "string",
- "group[org_schedule]": [
- "string"
]
}| id required | string |
| group[consent_enabled] required | boolean Is consent enabled for this organization? |
| group[name] | string The name of the group. |
| group[description] | string Description of the group |
| group[founded_year] | number The year the group was founded. |
| group[logo_data_uri] | string Base64 encoded string of the image to be used for the organization logo. |
| group[org_schedule] | Array of strings The hours of operation for the organization. |
{- "group[consent_enabled]": true,
- "group[name]": "string",
- "group[description]": "string",
- "group[founded_year]": 0,
- "group[logo_data_uri]": "string",
- "group[org_schedule]": [
- "string"
]
}| group_id required | string |
| page | number The page of results to be returned. |
| per | number The number of records to be returned per page. |
| sord | string Enum: "asc" "desc" The order to sort the results. |
| sidx | string The attribute to sort the results by. |
| q[service_types] | Array of strings Array of service type IDs to filter results by. |
| group_id required | string |
| page | number The page of results to be returned. |
| per | number The number of records to be returned per page. |
| sord | string Enum: "asc" "desc" The order to sort the results. |
| sidx | string The attribute to sort the results by. |
| q[service_types] | Array of strings Array of service type IDs to filter results by. |
| group_id required | string |
| page | number The page of results to be returned. |
| per | number The number of records to be returned per page. |
| sord | string Enum: "asc" "desc" The order to sort the results. |
| sidx | string The attribute to sort the results by. |
| q[service_types] | Array of strings Array of service type IDs to filter results by. |
| group_id required | string |
| page | number The page of results to be returned. |
| per | number The number of records to be returned per page. |
| sord | string Enum: "asc" "desc" The order to sort the results. |
| sidx | string The attribute to sort the results by. |
| q[service_types] | Array of strings Array of service type IDs to filter results by. |
| group_id required | string |
| page | number The page of results to be returned. |
| per | number The number of records to be returned per page. |
| sord | string Enum: "asc" "desc" The order to sort the results. |
| sidx | string The attribute to sort the results by. |
| q[service_types] | Array of strings Array of service type IDs to filter results by. |
| group_id required | string |
| page | number The page of results to be returned. |
| per | number The number of records to be returned per page. |
| sord | string Enum: "asc" "desc" The order to sort the results. |
| sidx | string The attribute to sort the results by. |
| q[service_types] | Array of strings Array of service type IDs to filter results by. |
| group_id required | string |
| closed | boolean Boolean value to hide or show only closed cases. Omit for open and closed. |
| primary_data_source | boolean Boolean to disable performance optimization for retrieving service cases. |
| q[service_types] | Array of strings Array of service type uuids on which to filter. |
| q[groups] | Array of strings Array of group uuids on which to filter. |
| q[networks] | Array of strings Array of network uuids on which to filter. |
| q[programs] | Array of strings Array of program uuids on which to filter. |
| q[care_coordinator_users] | Array of strings Array of user uuids on which to filter. |
| q[primary_worker_users] | Array of strings Array of user uuids on which to filter. |
| q[resolved] | boolean Boolean value - true for resolved, false for unresolved. Omit for all. |
| q[network_inclusion_scope] | string Enum: "in" "out" Cases in or out of network. Omit for both. |
| q[provider_scope] | string Enum: "group" "network" Case manged by a network or group. Omit for both. |
| page | number The page of results to be returned. |
| per | number The number of records to be returned per page. |
| sord | string Enum: "asc" "desc" The order to sort the results. |
| sidx | string The attribute to sort the results by. |
| group_id required | string |
| closed | boolean Boolean value to hide or show only closed cases. Omit for open and closed. |
| primary_data_source | boolean Boolean to disable performance optimization for retrieving service cases. |
| q[service_types] | Array of strings Array of service type uuids on which to filter. |
| q[groups] | Array of strings Array of group uuids on which to filter. |
| q[networks] | Array of strings Array of network uuids on which to filter. |
| q[programs] | Array of strings Array of program uuids on which to filter. |
| q[care_coordinator_users] | Array of strings Array of user uuids on which to filter. |
| q[primary_worker_users] | Array of strings Array of user uuids on which to filter. |
| q[resolved] | boolean Boolean value - true for resolved, false for unresolved. Omit for all. |
| q[network_inclusion_scope] | string Enum: "in" "out" Cases in or out of network. Omit for both. |
| q[provider_scope] | string Enum: "group" "network" Case manged by a network or group. Omit for both. |
| page | number The page of results to be returned. |
| per | number The number of records to be returned per page. |
| sord | string Enum: "asc" "desc" The order to sort the results. |
| sidx | string The attribute to sort the results by. |
| group_id required | string |
| closed | boolean Boolean value to hide or show only closed cases. Omit for open and closed. |
| primary_data_source | boolean Boolean to disable performance optimization for retrieving service cases. |
| q[service_types] | Array of strings Array of service type uuids on which to filter. |
| q[groups] | Array of strings Array of group uuids on which to filter. |
| q[networks] | Array of strings Array of network uuids on which to filter. |
| q[programs] | Array of strings Array of program uuids on which to filter. |
| q[care_coordinator_users] | Array of strings Array of user uuids on which to filter. |
| q[primary_worker_users] | Array of strings Array of user uuids on which to filter. |
| q[resolved] | boolean Boolean value - true for resolved, false for unresolved. Omit for all. |
| q[network_inclusion_scope] | string Enum: "in" "out" Cases in or out of network. Omit for both. |
| q[provider_scope] | string Enum: "group" "network" Case manged by a network or group. Omit for both. |
| page | number The page of results to be returned. |
| per | number The number of records to be returned per page. |
| sord | string Enum: "asc" "desc" The order to sort the results. |
| sidx | string The attribute to sort the results by. |
| group_id required | string |
| closed | boolean Boolean value to hide or show only closed cases. Omit for open and closed. |
| primary_data_source | boolean Boolean to disable performance optimization for retrieving service cases. |
| q[service_types] | Array of strings Array of service type uuids on which to filter. |
| q[groups] | Array of strings Array of group uuids on which to filter. |
| q[networks] | Array of strings Array of network uuids on which to filter. |
| q[programs] | Array of strings Array of program uuids on which to filter. |
| q[care_coordinator_users] | Array of strings Array of user uuids on which to filter. |
| q[primary_worker_users] | Array of strings Array of user uuids on which to filter. |
| q[resolved] | boolean Boolean value - true for resolved, false for unresolved. Omit for all. |
| q[network_inclusion_scope] | string Enum: "in" "out" Cases in or out of network. Omit for both. |
| q[provider_scope] | string Enum: "group" "network" Case manged by a network or group. Omit for both. |
| page | number The page of results to be returned. |
| per | number The number of records to be returned per page. |
| sord | string Enum: "asc" "desc" The order to sort the results. |
| sidx | string The attribute to sort the results by. |
| group_id required | string |
| closed | boolean Boolean value to hide or show only closed cases. Omit for open and closed. |
| primary_data_source | boolean Boolean to disable performance optimization for retrieving service cases. |
| q[service_types] | Array of strings Array of service type uuids on which to filter. |
| q[groups] | Array of strings Array of group uuids on which to filter. |
| q[networks] | Array of strings Array of network uuids on which to filter. |
| q[programs] | Array of strings Array of program uuids on which to filter. |
| q[care_coordinator_users] | Array of strings Array of user uuids on which to filter. |
| q[primary_worker_users] | Array of strings Array of user uuids on which to filter. |
| q[resolved] | boolean Boolean value - true for resolved, false for unresolved. Omit for all. |
| q[network_inclusion_scope] | string Enum: "in" "out" Cases in or out of network. Omit for both. |
| q[provider_scope] | string Enum: "group" "network" Case manged by a network or group. Omit for both. |
| page | number The page of results to be returned. |
| per | number The number of records to be returned per page. |
| sord | string Enum: "asc" "desc" The order to sort the results. |
| sidx | string The attribute to sort the results by. |
| group_id required | string |
| closed | boolean Boolean value to hide or show only closed cases. Omit for open and closed. |
| q[referral_sender_users] | Array of strings Array of referral sending user uuids. |
| q[service_types] | Array of strings Array of service type uuids. |
| q[resolved] | boolean Boolean value - true for resolved, false for unresolved. Omit for all. |
| page | number The page of results to be returned. |
| per | number The number of records to be returned per page. |
| sord | string Enum: "asc" "desc" The order to sort the results. |
| sidx | string The attribute to sort the results by. |
| group_id required | string |
| page | number The page of results to be returned. |
| per | number The number of records to be returned per page. |
| sord | string Enum: "asc" "desc" The order to sort the results. |
| sidx | string The attribute to sort the results by. |
| referral_id required | string |
| group_id required | string |
| closing[outcome_id] required | string The id of the outcome this closing is associated with |
| closing[status] required | string Enum: "resolved" "unresolved" The status of the case; either |
| closing[note] | string A note pertaining to the closing |
{- "closing[outcome_id]": "string",
- "closing[status]": "resolved",
- "closing[note]": "string"
}| referral_id required | string |
| group_id required | string |
| closing[outcome_id] required | string The id of the outcome this closing is associated with |
| closing[status] required | string Enum: "resolved" "unresolved" The status of the case; either |
| closing[note] | string A note pertaining to the closing |
{- "closing[outcome_id]": "string",
- "closing[status]": "resolved",
- "closing[note]": "string"
}| group_id required | string |
| page | number The page of results to be returned. |
| per | number The number of records to be returned per page. |
| sord | string Enum: "asc" "desc" The order to sort the results. |
| sidx | string The attribute to sort the results by. |
| id required | string |
| group_id required | string |
| referral[description] | string Referral notes or description. |
| referral[referred_by_network_id] | string Network from which the referral will be sent. |
| referral[referred_to_network_id] | string Network to which the referral will be sent. |
| referral[service_type] | string Service type for the referral. |
| referral[documents] | Array of strings |
{- "referral[description]": "string",
- "referral[referred_by_network_id]": "string",
- "referral[referred_to_network_id]": "string",
- "referral[service_type]": "string",
- "referral[documents]": [
- "string"
]
}| id required | string |
| group_id required | string |
| referral[description] | string Referral notes or description. |
| referral[referred_by_network_id] | string Network from which the referral will be sent. |
| referral[referred_to_network_id] | string Network to which the referral will be sent. |
| referral[service_type] | string Service type for the referral. |
| referral[documents] | Array of strings |
{- "referral[description]": "string",
- "referral[referred_by_network_id]": "string",
- "referral[referred_to_network_id]": "string",
- "referral[service_type]": "string",
- "referral[documents]": [
- "string"
]
}Filtered activity stream or timeline events are returned loosely based on the Activity Stream specification (activitystrea.ms).
Available verb values include: accept,
add, assign, close,
complete, create, delete,
deny, join, leave,
open, post, replace,
retract, save, send, and
update.
Use the verb, object, and target values to determine the event that occurred.
| group_id required | string |
| q[filter_names] | string Enum: "client_updates" "closed_records" "notes" "record_updates" "network_updates" "care_team" Name of filter to be appliied |
| page | number The page of results to be returned. |
| per | number The number of records to be returned per page. |
| sord | string Enum: "asc" "desc" The order to sort the results. |
| sidx | string The attribute to sort the results by. |
{- "q[filter_names]": "client_updates",
- "page": 0,
- "per": 0,
- "sord": "asc",
- "sidx": "string"
}| group_id required | string |
| q[use_type] | string Enum: "intake" "exit" "general" "screening" "any" Limit the available forms returned to the specified use type. |
| q[service_type_ids] | Array of strings Identifiers of the service type(s) being provided. |
| q[network_ids] | string Identifiers of the Network(s) being used to provide the service. |
| q[program_id] | string Identifier of the Program being used to provide the service. |
| q[contact_id] | string Identifier of the Contact that will be attached to the used forms. |
| page | number The page of results to be returned. |
| per | number The number of records to be returned per page. |
| sord | string Enum: "asc" "desc" The order to sort the results. |
| sidx | string The attribute to sort the results by. |
| group_id required | string |
| schedule[week] | Array of strings The hours of operation for the provided day |
{- "schedule[week]": [
- "string"
]
}| group_id required | string |
| schedule[week] | Array of strings The hours of operation for the provided day |
{- "schedule[week]": [
- "string"
]
}| group_id required | string |
| schedule[week] | Array of strings The hours of operation for the provided day |
{- "schedule[week]": [
- "string"
]
}| group_id required | string |
| schedule[week] | Array of strings The hours of operation for the provided day |
{- "schedule[week]": [
- "string"
]
}| group_id required | string |
| page | number The page of results to be returned. |
| per | number The number of records to be returned per page. |
| sord | string Enum: "asc" "desc" The order to sort the results. |
| sidx | string The attribute to sort the results by. |
| group_id required | string |
| page | number The page of results to be returned. |
| per | number The number of records to be returned per page. |
| sord | string Enum: "asc" "desc" The order to sort the results. |
| sidx | string The attribute to sort the results by. |
| group_id required | string |
| page | number The page of results to be returned. |
| per | number The number of records to be returned per page. |
| sord | string Enum: "asc" "desc" The order to sort the results. |
| sidx | string The attribute to sort the results by. |
| group_id required | string |
| page | number The page of results to be returned. |
| per | number The number of records to be returned per page. |
| sord | string Enum: "asc" "desc" The order to sort the results. |
| sidx | string The attribute to sort the results by. |
| group_id required | string |
| page | number The page of results to be returned. |
| per | number The number of records to be returned per page. |
| sord | string Enum: "asc" "desc" The order to sort the results. |
| sidx | string The attribute to sort the results by. |
| group_id required | string |
| page | number The page of results to be returned. |
| per | number The number of records to be returned per page. |
| sord | string Enum: "asc" "desc" The order to sort the results. |
| sidx | string The attribute to sort the results by. |
| group_id required | string |
| page | number The page of results to be returned. |
| per | number The number of records to be returned per page. |
| sord | string Enum: "asc" "desc" The order to sort the results. |
| sidx | string The attribute to sort the results by. |
| group_id required | string |
| page | number The page of results to be returned. |
| per | number The number of records to be returned per page. |
| sord | string Enum: "asc" "desc" The order to sort the results. |
| sidx | string The attribute to sort the results by. |
| group_id required | string |
| page | number The page of results to be returned. |
| per | number The number of records to be returned per page. |
| sord | string Enum: "asc" "desc" The order to sort the results. |
| sidx | string The attribute to sort the results by. |
| group_id required | string |
| page | number The page of results to be returned. |
| per | number The number of records to be returned per page. |
| sord | string Enum: "asc" "desc" The order to sort the results. |
| sidx | string The attribute to sort the results by. |
| group_id required | string |
| page | number The page of results to be returned. |
| per | number The number of records to be returned per page. |
| sord | string Enum: "asc" "desc" The order to sort the results. |
| sidx | string The attribute to sort the results by. |
| program_id required | string |
| group_id required | string |
| q[text] | string Query to search user's first or last name |
| q[employ_state] | string Enum: "is_active" "is_inactive" "any" Filter the results returned by the user's employment status with the group. |
| page | number The page of results to be returned. |
| per | number The number of records to be returned per page. |
| sord | string Enum: "asc" "desc" The order to sort the results. |
| sidx | string The attribute to sort the results by. |
| group_id required | string |
| page | number The page of results to be returned. |
| per | number The number of records to be returned per page. |
| sord | string Enum: "asc" "desc" The order to sort the results. |
| sidx | string The attribute to sort the results by. |
| referral_id required | string |
| group_id required | string |
| contact[first_name] | string Contact's first name. |
| contact[last_name] | string Contact's last name. |
| contact[email] | string Contact's email address. |
| contact[date_of_birth] | number Unix (epoch) timestamp representing the contact's date of birth. |
| contact[gender] | string Enum: "male" "female" "undisclosed" "non-binary" "other" Contact's specified gender. |
| contact[citizenship] | string Enum: "us-citizen" "us-national" "lawful-permanent-resident" "other" "undisclosed" Contact's specified citizenship. |
| contact[ethnicity] | string Enum: "hispanic-or-latino" "not-hispanic-or-latino" "undisclosed" Contact's specified ethnicity. |
| contact[marital_status] | string Enum: "divorced" "domestic_partner" "married-civil-union" "single/never-married" "separated" "undisclosed" "widowed" Contact's specified marital status. |
| contact[race] | string Enum: "american-indian-alaska-native" "asian" "black-african-american" "native-hawaiian-or-pacific-islander" "other-race" "undisclosed" "white" Contact's specified race. |
| contact[email_address] | string Contact's primary email address. |
| contact[preferred_first_name] | string Contact's preferred first name. |
| contact[title] | string Enum: "Mr." "Miss" "Mrs." "Ms." "Dr." Contact's title. |
| contact[middle_name_initial] | string Contact's middle name or initial. |
| contact[suffix] | string Enum: "Jr." "Sr." "III" "IV" "V" "Esq." "Ph.D" Contact's suffix. |
| contact[nicknames] | Array of strings Contact's nicknames. |
| contact[addresses] | Array of strings |
| contact[email_addresses] | Array of strings |
| contact[phone_numbers] | Array of strings |
| contact[military][affiliation] | string Enum: "military_member_or_veteran" "spouse" "widow" "family_member" "caregiver" "prefer_not_to_disclose" Military affiliation |
| contact[military][current_status] | string Enum: "active_duty" "national_guard" "reserve" "retiree" "veteran" "prefer_not_to_disclose" Current military status |
| contact[military][currently_transitioning] | string Enum: "yes_12mos_before" "yes_12mos_after" "no" "prefer_not_to_disclose" Is the contact currently transitioning? |
| contact[military][at_least_one_day_active_duty] | string Enum: "yes" "no" "prefer_not_to_disclose" Has at least one day of active duty outside of basic training? |
| contact[military][branch] | string Enum: "air_force" "army" "coast_guard" "marines" "navy" "prefer_not_to_disclose" Branch of service |
| contact[military][service_era] | string Enum: "post_911" "persian_gulf" "post_vietnam" "vietnam" "post_korean" "korean_war" "pre_korean" "ww2" "merchant_marine" "ww1" "prefer_not_to_disclose" Service era |
| contact[military][entry_date] | number Date of entry |
| contact[military][exit_date] | number Date of exit |
| contact[military][deployed] | string Enum: "yes" "no" "prefer_not_to_disclose" Deployed? |
| contact[military][deployment_starts_at] | number Deployment start date |
| contact[military][deployment_ends_at] | number Deployment end date |
| contact[military][discharge_type] | string Enum: "honorable" "general" "other_than_honorable" "bad_conduct" "dishonorable" "uncharacterized" "other" "prefer_not_to_disclose" Discharge type |
| contact[military][discharged_due_to_disability] | string Enum: "yes" "no" "prefer_not_to_disclose" Discharged or retired from military service for a disability incurred in the line of duty? |
| contact[military][service_connected_disability] | string Enum: "yes" "no" "prefer_not_to_disclose" Has VA-rated Service-Connected Disability? |
| contact[military][service_connected_disability_rating] | string Enum: "0" "10" "20" "30" "40" "50" "60" "70" "80" "90" "100" "prefer_not_to_disclose" Service-Connected Disability Rating |
| contact[military][proof_of_veteran_status] | string Enum: "yes" "no" "prefer_not_to_disclose" Have proof of veteran status? |
| contact[military][proof_type] | string Enum: "dd214" "va_id" "statement_of_service" "retiree_id" "drivers_license" "military_id" "other" "prefer_not_to_disclose" Proof type |
| contact[data] | Array of strings |
{- "contact[first_name]": "string",
- "contact[last_name]": "string",
- "contact[email]": "string",
- "contact[date_of_birth]": 0,
- "contact[gender]": "male",
- "contact[citizenship]": "us-citizen",
- "contact[ethnicity]": "hispanic-or-latino",
- "contact[marital_status]": "divorced",
- "contact[race]": "american-indian-alaska-native",
- "contact[email_address]": "string",
- "contact[preferred_first_name]": "string",
- "contact[title]": "Mr.",
- "contact[middle_name_initial]": "string",
- "contact[suffix]": "Jr.",
- "contact[nicknames]": [
- "string"
], - "contact[addresses]": [
- "string"
], - "contact[email_addresses]": [
- "string"
], - "contact[phone_numbers]": [
- "string"
], - "contact[military][affiliation]": "military_member_or_veteran",
- "contact[military][current_status]": "active_duty",
- "contact[military][currently_transitioning]": "yes_12mos_before",
- "contact[military][at_least_one_day_active_duty]": "yes",
- "contact[military][branch]": "air_force",
- "contact[military][service_era]": "post_911",
- "contact[military][entry_date]": 0,
- "contact[military][exit_date]": 0,
- "contact[military][deployed]": "yes",
- "contact[military][deployment_starts_at]": 0,
- "contact[military][deployment_ends_at]": 0,
- "contact[military][discharge_type]": "honorable",
- "contact[military][discharged_due_to_disability]": "yes",
- "contact[military][service_connected_disability]": "yes",
- "contact[military][service_connected_disability_rating]": "0",
- "contact[military][proof_of_veteran_status]": "yes",
- "contact[military][proof_type]": "dd214",
- "contact[data]": [
- "string"
]
}| referral_id required | string |
| group_id required | string |
| contact[first_name] | string Contact's first name. |
| contact[last_name] | string Contact's last name. |
| contact[email] | string Contact's email address. |
| contact[date_of_birth] | number Unix (epoch) timestamp representing the contact's date of birth. |
| contact[gender] | string Enum: "male" "female" "undisclosed" "non-binary" "other" Contact's specified gender. |
| contact[citizenship] | string Enum: "us-citizen" "us-national" "lawful-permanent-resident" "other" "undisclosed" Contact's specified citizenship. |
| contact[ethnicity] | string Enum: "hispanic-or-latino" "not-hispanic-or-latino" "undisclosed" Contact's specified ethnicity. |
| contact[marital_status] | string Enum: "divorced" "domestic_partner" "married-civil-union" "single/never-married" "separated" "undisclosed" "widowed" Contact's specified marital status. |
| contact[race] | string Enum: "american-indian-alaska-native" "asian" "black-african-american" "native-hawaiian-or-pacific-islander" "other-race" "undisclosed" "white" Contact's specified race. |
| contact[email_address] | string Contact's primary email address. |
| contact[preferred_first_name] | string Contact's preferred first name. |
| contact[title] | string Enum: "Mr." "Miss" "Mrs." "Ms." "Dr." Contact's title. |
| contact[middle_name_initial] | string Contact's middle name or initial. |
| contact[suffix] | string Enum: "Jr." "Sr." "III" "IV" "V" "Esq." "Ph.D" Contact's suffix. |
| contact[nicknames] | Array of strings Contact's nicknames. |
| contact[addresses] | Array of strings |
| contact[email_addresses] | Array of strings |
| contact[phone_numbers] | Array of strings |
| contact[military][affiliation] | string Enum: "military_member_or_veteran" "spouse" "widow" "family_member" "caregiver" "prefer_not_to_disclose" Military affiliation |
| contact[military][current_status] | string Enum: "active_duty" "national_guard" "reserve" "retiree" "veteran" "prefer_not_to_disclose" Current military status |
| contact[military][currently_transitioning] | string Enum: "yes_12mos_before" "yes_12mos_after" "no" "prefer_not_to_disclose" Is the contact currently transitioning? |
| contact[military][at_least_one_day_active_duty] | string Enum: "yes" "no" "prefer_not_to_disclose" Has at least one day of active duty outside of basic training? |
| contact[military][branch] | string Enum: "air_force" "army" "coast_guard" "marines" "navy" "prefer_not_to_disclose" Branch of service |
| contact[military][service_era] | string Enum: "post_911" "persian_gulf" "post_vietnam" "vietnam" "post_korean" "korean_war" "pre_korean" "ww2" "merchant_marine" "ww1" "prefer_not_to_disclose" Service era |
| contact[military][entry_date] | number Date of entry |
| contact[military][exit_date] | number Date of exit |
| contact[military][deployed] | string Enum: "yes" "no" "prefer_not_to_disclose" Deployed? |
| contact[military][deployment_starts_at] | number Deployment start date |
| contact[military][deployment_ends_at] | number Deployment end date |
| contact[military][discharge_type] | string Enum: "honorable" "general" "other_than_honorable" "bad_conduct" "dishonorable" "uncharacterized" "other" "prefer_not_to_disclose" Discharge type |
| contact[military][discharged_due_to_disability] | string Enum: "yes" "no" "prefer_not_to_disclose" Discharged or retired from military service for a disability incurred in the line of duty? |
| contact[military][service_connected_disability] | string Enum: "yes" "no" "prefer_not_to_disclose" Has VA-rated Service-Connected Disability? |
| contact[military][service_connected_disability_rating] | string Enum: "0" "10" "20" "30" "40" "50" "60" "70" "80" "90" "100" "prefer_not_to_disclose" Service-Connected Disability Rating |
| contact[military][proof_of_veteran_status] | string Enum: "yes" "no" "prefer_not_to_disclose" Have proof of veteran status? |
| contact[military][proof_type] | string Enum: "dd214" "va_id" "statement_of_service" "retiree_id" "drivers_license" "military_id" "other" "prefer_not_to_disclose" Proof type |
| contact[data] | Array of strings |
{- "contact[first_name]": "string",
- "contact[last_name]": "string",
- "contact[email]": "string",
- "contact[date_of_birth]": 0,
- "contact[gender]": "male",
- "contact[citizenship]": "us-citizen",
- "contact[ethnicity]": "hispanic-or-latino",
- "contact[marital_status]": "divorced",
- "contact[race]": "american-indian-alaska-native",
- "contact[email_address]": "string",
- "contact[preferred_first_name]": "string",
- "contact[title]": "Mr.",
- "contact[middle_name_initial]": "string",
- "contact[suffix]": "Jr.",
- "contact[nicknames]": [
- "string"
], - "contact[addresses]": [
- "string"
], - "contact[email_addresses]": [
- "string"
], - "contact[phone_numbers]": [
- "string"
], - "contact[military][affiliation]": "military_member_or_veteran",
- "contact[military][current_status]": "active_duty",
- "contact[military][currently_transitioning]": "yes_12mos_before",
- "contact[military][at_least_one_day_active_duty]": "yes",
- "contact[military][branch]": "air_force",
- "contact[military][service_era]": "post_911",
- "contact[military][entry_date]": 0,
- "contact[military][exit_date]": 0,
- "contact[military][deployed]": "yes",
- "contact[military][deployment_starts_at]": 0,
- "contact[military][deployment_ends_at]": 0,
- "contact[military][discharge_type]": "honorable",
- "contact[military][discharged_due_to_disability]": "yes",
- "contact[military][service_connected_disability]": "yes",
- "contact[military][service_connected_disability_rating]": "0",
- "contact[military][proof_of_veteran_status]": "yes",
- "contact[military][proof_type]": "dd214",
- "contact[data]": [
- "string"
]
}| form_id required | string |
| referral_id required | string |
| group_id required | string |
| data | Array of strings |
{- "data": [
- "string"
]
}| form_id required | string |
| referral_id required | string |
| group_id required | string |
| data | Array of strings |
{- "data": [
- "string"
]
}| id required | string |
| group_id required | string |
| referral[description] | string Referral notes or description. |
| referral[referred_by_network_id] | string Network from which the referral will be sent. |
| referral[referred_to_network_id] | string Network to which the referral will be sent. |
| referral[service_type] | string Service type for the referral. |
| referral[documents] | Array of strings |
{- "referral[description]": "string",
- "referral[referred_by_network_id]": "string",
- "referral[referred_to_network_id]": "string",
- "referral[service_type]": "string",
- "referral[documents]": [
- "string"
]
}| id required | string |
| group_id required | string |
| referral[description] | string Referral notes or description. |
| referral[referred_by_network_id] | string Network from which the referral will be sent. |
| referral[referred_to_network_id] | string Network to which the referral will be sent. |
| referral[service_type] | string Service type for the referral. |
| referral[documents] | Array of strings |
{- "referral[description]": "string",
- "referral[referred_by_network_id]": "string",
- "referral[referred_to_network_id]": "string",
- "referral[service_type]": "string",
- "referral[documents]": [
- "string"
]
}| group_id required | string |
| page | number The page of results to be returned. |
| per | number The number of records to be returned per page. |
| sord | string Enum: "asc" "desc" The order to sort the results. |
| sidx | string The attribute to sort the results by. |
| group_id required | string |
| page | number The page of results to be returned. |
| per | number The number of records to be returned per page. |
| sord | string Enum: "asc" "desc" The order to sort the results. |
| sidx | string The attribute to sort the results by. |
| group_id required | string |
| page | number The page of results to be returned. |
| per | number The number of records to be returned per page. |
| sord | string Enum: "asc" "desc" The order to sort the results. |
| sidx | string The attribute to sort the results by. |
| group_id required | string |
| page | number The page of results to be returned. |
| per | number The number of records to be returned per page. |
| sord | string Enum: "asc" "desc" The order to sort the results. |
| sidx | string The attribute to sort the results by. |
| group_id required | string |
| page | number The page of results to be returned. |
| per | number The number of records to be returned per page. |
| sord | string Enum: "asc" "desc" The order to sort the results. |
| sidx | string The attribute to sort the results by. |
| group_id required | string |
| page | number The page of results to be returned. |
| per | number The number of records to be returned per page. |
| sord | string Enum: "asc" "desc" The order to sort the results. |
| sidx | string The attribute to sort the results by. |
| group_id required | string |
| page | number The page of results to be returned. |
| per | number The number of records to be returned per page. |
| sord | string Enum: "asc" "desc" The order to sort the results. |
| sidx | string The attribute to sort the results by. |
| group_id required | string |
| page | number The page of results to be returned. |
| per | number The number of records to be returned per page. |
| sord | string Enum: "asc" "desc" The order to sort the results. |
| sidx | string The attribute to sort the results by. |
| group_id required | string |
| page | number The page of results to be returned. |
| per | number The number of records to be returned per page. |
| sord | string Enum: "asc" "desc" The order to sort the results. |
| sidx | string The attribute to sort the results by. |
| group_id required | string |
| page | number The page of results to be returned. |
| per | number The number of records to be returned per page. |
| sord | string Enum: "asc" "desc" The order to sort the results. |
| sidx | string The attribute to sort the results by. |
| group_id required | string |
| page | number The page of results to be returned. |
| per | number The number of records to be returned per page. |
| sord | string Enum: "asc" "desc" The order to sort the results. |
| sidx | string The attribute to sort the results by. |
| group_id required | string |
| page | number The page of results to be returned. |
| per | number The number of records to be returned per page. |
| sord | string Enum: "asc" "desc" The order to sort the results. |
| sidx | string The attribute to sort the results by. |
| group_id required | string |
| page | number The page of results to be returned. |
| per | number The number of records to be returned per page. |
| sord | string Enum: "asc" "desc" The order to sort the results. |
| sidx | string The attribute to sort the results by. |
| group_id required | string |
| page | number The page of results to be returned. |
| per | number The number of records to be returned per page. |
| sord | string Enum: "asc" "desc" The order to sort the results. |
| sidx | string The attribute to sort the results by. |
| group_id required | string |
| page | number The page of results to be returned. |
| per | number The number of records to be returned per page. |
| sord | string Enum: "asc" "desc" The order to sort the results. |
| sidx | string The attribute to sort the results by. |
| group_id required | string |
| page | number The page of results to be returned. |
| per | number The number of records to be returned per page. |
| sord | string Enum: "asc" "desc" The order to sort the results. |
| sidx | string The attribute to sort the results by. |
| group_id required | string |
| q[last_name] required | string Last name of contact being queried. |
| q[first_name] required | string First name of the contact being queried. |
| q[ssn] | string Complete Social Security Number of contact being queried. (not yet supported) |
| q[ssn_last4] | string Last 4 digits of Social Security Number of contact being queried. (not yet supported) |
| q[date_of_birth] | string UNIX timestamp representing the birth date of the contact being queried. |
{- "q[last_name]": "string",
- "q[first_name]": "string",
- "q[ssn]": "string",
- "q[ssn_last4]": "string",
- "q[date_of_birth]": "string"
}| form_id required | string |
| service_case_id required | string |
| group_id required | string |
| data | Array of strings |
{- "data": [
- "string"
]
}| form_id required | string |
| service_case_id required | string |
| group_id required | string |
| data | Array of strings |
{- "data": [
- "string"
]
}| service_type_id required | string |
| group_id required | string |
| page | number The page of results to be returned. |
| per | number The number of records to be returned per page. |
| sord | string Enum: "asc" "desc" The order to sort the results. |
| sidx | string The attribute to sort the results by. |
Activity Stream or Timeline events are returned loosely based on the Activity Stream specification (activitystrea.ms).
Available verb values include: accept,
add, assign, close,
complete, create, delete,
deny, join, leave,
open, post, replace,
retract, save, send, and
update.
Use the verb, object, and target values to determine the event that occurred.
| group_id required | string |
| page | number The page of results to be returned. |
| per | number The number of records to be returned per page. |
| sord | string Enum: "asc" "desc" The order to sort the results. |
| sidx | string The attribute to sort the results by. |
Organization Administrators Accept Participation Agreement on Behalf of a Group
| group_id required | string |
| page | number The page of results to be returned. |
| per | number The number of records to be returned per page. |
| sord | string Enum: "asc" "desc" The order to sort the results. |
| sidx | string The attribute to sort the results by. |
| group_id required | string |
| invitation[last_name] required | string Last name of the invitation recipient. |
| invitation[first_name] required | string First name of the invitation recipient. |
| invitation[email] required | string Email address where the invitation should be delivered. |
| invitation[send_immediately] | boolean Should the invitation be delivered immediately. Defaults to false. |
{- "invitation[last_name]": "string",
- "invitation[first_name]": "string",
- "invitation[email]": "string",
- "invitation[send_immediately]": true
}| id required | string |
| group_id required | string |
| invitation[email] | string Email address where the invitation should be delivered. |
| invitation[first_name] | string First name of the invitation recipient. |
| invitation[last_name] | string Last name of the invitation recipient. |
| invitation[send_immediately] | boolean Should the invitation be delivered immediately. Defaults to false. |
{- "invitation[email]": "string",
- "invitation[first_name]": "string",
- "invitation[last_name]": "string",
- "invitation[send_immediately]": true
}| id required | string |
| group_id required | string |
| invitation[email] | string Email address where the invitation should be delivered. |
| invitation[first_name] | string First name of the invitation recipient. |
| invitation[last_name] | string Last name of the invitation recipient. |
| invitation[send_immediately] | boolean Should the invitation be delivered immediately. Defaults to false. |
{- "invitation[email]": "string",
- "invitation[first_name]": "string",
- "invitation[last_name]": "string",
- "invitation[send_immediately]": true
}| group_id required | string |
| user[profile][gender] required | string Enum: "male" "female" "undisclosed" "non-binary" "other" User's specified gender. |
| q[text] | string Query to search user's first or last name |
| q[employ_state] | string Enum: "is_active" "is_inactive" "any" Filter the results returned by the user's employment status with the group. |
| page | number The page of results to be returned. |
| per | number The number of records to be returned per page. |
| sord | string Enum: "asc" "desc" The order to sort the results. |
| sidx | string The attribute to sort the results by. |
| user[email] | string User's email address. |
| user[first_name] | string User's first name. |
| user[last_name] | string User's last name. |
| user[password] | string User's preferred password, only if changing it. |
| user[password_confirmation] | string Confirmation of user's preferred password, only if changing it. |
| user[profile][description] | string User's profile description or bio text. |
| user[work_title] | string User's work title or position name. |
| group_licenses | Array of strings |
| network_licenses | Array of strings |
| role_ids | Array of strings Identifiers for the roles to assign to the user. |
| group_id required | string |
| user[profile][gender] required | string Enum: "male" "female" "undisclosed" "non-binary" "other" User's specified gender. |
| q[text] | string Query to search user's first or last name |
| q[employ_state] | string Enum: "is_active" "is_inactive" "any" Filter the results returned by the user's employment status with the group. |
| page | number The page of results to be returned. |
| per | number The number of records to be returned per page. |
| sord | string Enum: "asc" "desc" The order to sort the results. |
| sidx | string The attribute to sort the results by. |
| user[email] | string User's email address. |
| user[first_name] | string User's first name. |
| user[last_name] | string User's last name. |
| user[password] | string User's preferred password, only if changing it. |
| user[password_confirmation] | string Confirmation of user's preferred password, only if changing it. |
| user[profile][description] | string User's profile description or bio text. |
| user[work_title] | string User's work title or position name. |
| group_licenses | Array of strings |
| network_licenses | Array of strings |
| role_ids | Array of strings Identifiers for the roles to assign to the user. |
{- "user[profile][gender]": "male",
- "q[text]": "string",
- "q[employ_state]": "is_active",
- "page": 0,
- "per": 0,
- "sord": "asc",
- "sidx": "string",
- "user[email]": "string",
- "user[first_name]": "string",
- "user[last_name]": "string",
- "user[password]": "string",
- "user[password_confirmation]": "string",
- "user[profile][description]": "string",
- "user[work_title]": "string",
- "group_licenses": [
- "string"
], - "network_licenses": [
- "string"
], - "role_ids": [
- "string"
]
}| user_id required | string |
| group_id required | string |
| user[profile][gender] required | string Enum: "male" "female" "undisclosed" "non-binary" "other" User's specified gender. |
| q[text] | string Query to search user's first or last name |
| q[employ_state] | string Enum: "is_active" "is_inactive" "any" Filter the results returned by the user's employment status with the group. |
| page | number The page of results to be returned. |
| per | number The number of records to be returned per page. |
| sord | string Enum: "asc" "desc" The order to sort the results. |
| sidx | string The attribute to sort the results by. |
| user[email] | string User's email address. |
| user[first_name] | string User's first name. |
| user[last_name] | string User's last name. |
| user[password] | string User's preferred password, only if changing it. |
| user[password_confirmation] | string Confirmation of user's preferred password, only if changing it. |
| user[profile][description] | string User's profile description or bio text. |
| user[work_title] | string User's work title or position name. |
| group_licenses | Array of strings |
| network_licenses | Array of strings |
| role_ids | Array of strings Identifiers for the roles to assign to the user. |
{- "user[profile][gender]": "male",
- "q[text]": "string",
- "q[employ_state]": "is_active",
- "page": 0,
- "per": 0,
- "sord": "asc",
- "sidx": "string",
- "user[email]": "string",
- "user[first_name]": "string",
- "user[last_name]": "string",
- "user[password]": "string",
- "user[password_confirmation]": "string",
- "user[profile][description]": "string",
- "user[work_title]": "string",
- "group_licenses": [
- "string"
], - "network_licenses": [
- "string"
], - "role_ids": [
- "string"
]
}| user_id required | string |
| group_id required | string |
| user[profile][gender] required | string Enum: "male" "female" "undisclosed" "non-binary" "other" User's specified gender. |
| q[text] | string Query to search user's first or last name |
| q[employ_state] | string Enum: "is_active" "is_inactive" "any" Filter the results returned by the user's employment status with the group. |
| page | number The page of results to be returned. |
| per | number The number of records to be returned per page. |
| sord | string Enum: "asc" "desc" The order to sort the results. |
| sidx | string The attribute to sort the results by. |
| user[email] | string User's email address. |
| user[first_name] | string User's first name. |
| user[last_name] | string User's last name. |
| user[password] | string User's preferred password, only if changing it. |
| user[password_confirmation] | string Confirmation of user's preferred password, only if changing it. |
| user[profile][description] | string User's profile description or bio text. |
| user[work_title] | string User's work title or position name. |
| group_licenses | Array of strings |
| network_licenses | Array of strings |
| role_ids | Array of strings Identifiers for the roles to assign to the user. |
{- "user[profile][gender]": "male",
- "q[text]": "string",
- "q[employ_state]": "is_active",
- "page": 0,
- "per": 0,
- "sord": "asc",
- "sidx": "string",
- "user[email]": "string",
- "user[first_name]": "string",
- "user[last_name]": "string",
- "user[password]": "string",
- "user[password_confirmation]": "string",
- "user[profile][description]": "string",
- "user[work_title]": "string",
- "group_licenses": [
- "string"
], - "network_licenses": [
- "string"
], - "role_ids": [
- "string"
]
}Filtered activity stream or timeline events are returned loosely based on the Activity Stream specification (activitystrea.ms).
Available verb values include: accept,
add, assign, close,
complete, create, delete,
deny, join, leave,
open, post, replace,
retract, save, send, and
update.
Use the verb, object, and target values to determine the event that occurred.
| service_case_id required | string |
| contact_id required | string |
| group_id required | string |
| q[filter_names] | string Enum: "client_updates" "closed_records" "notes" "record_updates" "network_updates" "care_team" Name of filter to be appliied |
| page | number The page of results to be returned. |
| per | number The number of records to be returned per page. |
| sord | string Enum: "asc" "desc" The order to sort the results. |
| sidx | string The attribute to sort the results by. |
{- "q[filter_names]": "client_updates",
- "page": 0,
- "per": 0,
- "sord": "asc",
- "sidx": "string"
}Activity Stream or Timeline events are returned loosely based on the Activity Stream specification (activitystrea.ms).
Available verb values include: accept,
add, assign, close,
complete, create, delete,
deny, join, leave,
open, post, replace,
retract, save, send, and
update.
Use the verb, object, and target values to determine the event that occurred.
| service_case_id required | string |
| contact_id required | string |
| group_id required | string |
| page | number The page of results to be returned. |
| per | number The number of records to be returned per page. |
| sord | string Enum: "asc" "desc" The order to sort the results. |
| sidx | string The attribute to sort the results by. |
| contact_id required | string |
| group_id required | string |
| page | number The page of results to be returned. |
| per | number The number of records to be returned per page. |
| sord | string Enum: "asc" "desc" The order to sort the results. |
| sidx | string The attribute to sort the results by. |
| contact_id required | string |
| group_id required | string |
| household_member[last_name] required | string Household Member's last name. |
| household_member[first_name] required | string Household Member's first name. |
| household_member[gender] | string Enum: "male" "female" "undisclosed" "non-binary" "other" Household Member's specified gender. |
| household_member[title] | string Enum: "Mr." "Miss" "Mrs." "Ms." "Dr." Household Member's title. |
| household_member[suffix] | string Enum: "Jr." "Sr." "III" "IV" "V" "Esq." "Ph.D" Household Member's suffix. |
| household_member[relation_to_primary] | string Enum: "self" "child" "spouse" "parent" "partner" "other-relation" "non-relation" Household Member's relationship to the Contact |
| household_member[date_of_birth] | number Unix (epoch) timestamp representing the contact's date of birth. |
| household_member[head_of_household] | boolean Is the household member the head of the household? |
{- "household_member[last_name]": "string",
- "household_member[first_name]": "string",
- "household_member[gender]": "male",
- "household_member[title]": "Mr.",
- "household_member[suffix]": "Jr.",
- "household_member[relation_to_primary]": "self",
- "household_member[date_of_birth]": 0,
- "household_member[head_of_household]": true
}| id required | string |
| contact_id required | string |
| group_id required | string |
| household_member[first_name] | string Household Member's first name. |
| household_member[last_name] | string Household Member's last name. |
| household_member[gender] | string Enum: "male" "female" "undisclosed" "non-binary" "other" Household Member's specified gender. |
| household_member[title] | string Enum: "Mr." "Miss" "Mrs." "Ms." "Dr." Household Member's title. |
| household_member[suffix] | string Enum: "Jr." "Sr." "III" "IV" "V" "Esq." "Ph.D" Household Member's suffix. |
| household_member[relation_to_primary] | string Enum: "self" "child" "spouse" "parent" "partner" "other-relation" "non-relation" Household Member's relationship to the Contact |
| household_member[date_of_birth] | number Unix (epoch) timestamp representing the contact's date of birth. |
| household_member[head_of_household] | boolean Is the household member the head of the household? |
{- "household_member[first_name]": "string",
- "household_member[last_name]": "string",
- "household_member[gender]": "male",
- "household_member[title]": "Mr.",
- "household_member[suffix]": "Jr.",
- "household_member[relation_to_primary]": "self",
- "household_member[date_of_birth]": 0,
- "household_member[head_of_household]": true
}| id required | string |
| contact_id required | string |
| group_id required | string |
| household_member[first_name] | string Household Member's first name. |
| household_member[last_name] | string Household Member's last name. |
| household_member[gender] | string Enum: "male" "female" "undisclosed" "non-binary" "other" Household Member's specified gender. |
| household_member[title] | string Enum: "Mr." "Miss" "Mrs." "Ms." "Dr." Household Member's title. |
| household_member[suffix] | string Enum: "Jr." "Sr." "III" "IV" "V" "Esq." "Ph.D" Household Member's suffix. |
| household_member[relation_to_primary] | string Enum: "self" "child" "spouse" "parent" "partner" "other-relation" "non-relation" Household Member's relationship to the Contact |
| household_member[date_of_birth] | number Unix (epoch) timestamp representing the contact's date of birth. |
| household_member[head_of_household] | boolean Is the household member the head of the household? |
{- "household_member[first_name]": "string",
- "household_member[last_name]": "string",
- "household_member[gender]": "male",
- "household_member[title]": "Mr.",
- "household_member[suffix]": "Jr.",
- "household_member[relation_to_primary]": "self",
- "household_member[date_of_birth]": 0,
- "household_member[head_of_household]": true
}| contact_id required | string |
| group_id required | string |
| total | number Total number of members in the Household |
| children | number Number of children in the Household |
| adults | number Number of adults in the Household |
| should_enable | boolean Should the |
{- "total": 0,
- "children": 0,
- "adults": 0,
- "should_enable": true
}| contact_id required | string |
| group_id required | string |
| total | number Total number of members in the Household |
| children | number Number of children in the Household |
| adults | number Number of adults in the Household |
| should_enable | boolean Should the |
{- "total": 0,
- "children": 0,
- "adults": 0,
- "should_enable": true
}| referral_id required | string |
| group_id required | string |
| referral_hold[reason] | string A reason for the referral being put in review. |
| referral_hold[note] | string A note concerning the referral being put in review. |
{- "referral_hold[reason]": "string",
- "referral_hold[note]": "string"
}| referral_id required | string |
| group_id required | string |
| referral_hold[reason] | string A reason for the referral being put in review. |
| referral_hold[note] | string A note concerning the referral being put in review. |
{- "referral_hold[reason]": "string",
- "referral_hold[note]": "string"
}| referral_id required | string |
| group_id required | string |
| referral[referred_to_program_id] | string ID of the Program to which the referral should be assigned |
{- "referral[referred_to_program_id]": "string"
}| referral_id required | string |
| group_id required | string |
| referral[referred_to_program_id] | string ID of the Program to which the referral should be assigned |
{- "referral[referred_to_program_id]": "string"
}| referral_id required | string |
| group_id required | string |
| referral_recall[reason] | string A reason for the referral being recalled |
| referral_recall[note] | string A note concerning the referral being recalled |
{- "referral_recall[reason]": "string",
- "referral_recall[note]": "string"
}| referral_id required | string |
| group_id required | string |
| referral_recall[reason] | string A reason for the referral being recalled |
| referral_recall[note] | string A note concerning the referral being recalled |
{- "referral_recall[reason]": "string",
- "referral_recall[note]": "string"
}| intake_id required | string |
| contact_id required | string |
| group_id required | string |
| page | number The page of results to be returned. |
| per | number The number of records to be returned per page. |
| sord | string Enum: "asc" "desc" The order to sort the results. |
| sidx | string The attribute to sort the results by. |
| id required | string |
| intake_id required | string |
| contact_id required | string |
| group_id required | string |
| document[title] required | string The name associated with the document |
| attach_to_id | string The ID of the object to change the document attachment to. |
{- "document[title]": "string",
- "attach_to_id": "string"
}| id required | string |
| intake_id required | string |
| contact_id required | string |
| group_id required | string |
| document[title] required | string The name associated with the document |
| attach_to_id | string The ID of the object to change the document attachment to. |
{- "document[title]": "string",
- "attach_to_id": "string"
}| token required | string |
| user[profile][gender] required | string Enum: "male" "female" "undisclosed" "non-binary" "other" User's specified gender. |
| user[email] | string User's email address. |
| user[first_name] | string User's first name. |
| user[last_name] | string User's last name. |
| user[password] | string User's preferred password, only if changing it. |
| user[password_confirmation] | string Confirmation of user's preferred password, only if changing it. |
| user[profile][description] | string User's profile description or bio text. |
| user[work_title] | string User's work title or position name. |
{- "user[profile][gender]": "male",
- "user[email]": "string",
- "user[first_name]": "string",
- "user[last_name]": "string",
- "user[password]": "string",
- "user[password_confirmation]": "string",
- "user[profile][description]": "string",
- "user[work_title]": "string"
}| token required | string |
| user[profile][gender] required | string Enum: "male" "female" "undisclosed" "non-binary" "other" User's specified gender. |
| user[email] | string User's email address. |
| user[first_name] | string User's first name. |
| user[last_name] | string User's last name. |
| user[password] | string User's preferred password, only if changing it. |
| user[password_confirmation] | string Confirmation of user's preferred password, only if changing it. |
| user[profile][description] | string User's profile description or bio text. |
| user[work_title] | string User's work title or position name. |
{- "user[profile][gender]": "male",
- "user[email]": "string",
- "user[first_name]": "string",
- "user[last_name]": "string",
- "user[password]": "string",
- "user[password_confirmation]": "string",
- "user[profile][description]": "string",
- "user[work_title]": "string"
}| network_id required | string |
| q[coordinates][lon] required | number Longitude Coordinate |
| q[coordinates][lat] required | number Latitude Coordinate |
| q[text] required | string Text to search the index for. |
| q[service_type_ids] | Array of strings An array of service type IDs to filter on |
| q[distance] | string Either a distance w/ unit OR no distance IOT fetch |
| q[delivery_options] | Array of strings An array of Program Delivery Method names to filter on |
| q[languages] | Array of strings An array of Program Lanugage names to filter on |
| q[accessibility_options] | Array of strings An array of Program Accessibility Option names to filter on |
| q[payment_options] | Array of strings An array of Program Fee payment options to filter on |
| q[transportation_options] | Array of strings An array of Program Transportation Option names to filter on |
| q[caters_to] | Array of strings An array of Program Catered To Population names to filter on |
| q[restricted_to] | Array of strings An array of Program Restricted To Population names to filter on |
| q[include_unlicensed_providers] | boolean Optionally include unlicensed providers |
| page | number The page of results to be returned. |
| per | number The number of records to be returned per page. |
| sord | string Enum: "asc" "desc" The order to sort the results. |
| sidx | string The attribute to sort the results by. |
| network_id required | string |
| q[service_type_ids] | Array of strings An array of service type IDs to match network groups with. |
| q[name] | string All or part of an organization name within the network to match. |
| page | number The page of results to be returned. |
| per | number The number of records to be returned per page. |
| sord | string Enum: "asc" "desc" The order to sort the results. |
| sidx | string The attribute to sort the results by. |
| group_id required | string |
| network_id required | string |
| q[include_home_groups] | boolean Optionally include all groups for any provided |
| q[permitted_networks] | Array of strings Identifiers of networks that should be used to determine a referral scope. |
| q[service_type_ids] | Array of strings An array of service type IDs to match network groups with. |
| q[name] | string All or part of an organization name within the network to match. |
| q[include_address_book] | boolean Optionally include address book groups with in network groups for the current group |
| q[only_address_book] | boolean Optionally only show address book groups for the current group |
| q[address_book_status] | string Enum: "draft" "in_review" "published" "archived" Optionally filter address book groups by their status |
| page | number The page of results to be returned. |
| per | number The number of records to be returned per page. |
| sord | string Enum: "asc" "desc" The order to sort the results. |
| sidx | string The attribute to sort the results by. |
| network_id required | string |
| q[group_id] required | string Identifier for the origin group used to find referral scopes (with network in scope as origin network) |
| q[text] | string All or part of a user's name or email within the network to match. |
| q[permitted_networks] | Array of strings Identifiers of networks that should be used to filter referral scopes. |
| page | number The page of results to be returned. |
| per | number The number of records to be returned per page. |
| sord | string Enum: "asc" "desc" The order to sort the results. |
| sidx | string The attribute to sort the results by. |
| id required | string |
| group_information_updated | boolean Group information has been updated |
| new_program_added | boolean New program has been added |
| group_admin_added | boolean User has been granted administrator role |
| group_user_changes | boolean Changes to users - added to org, removed from org, role changed |
| watch_my_contacts | boolean Updates and changes to contacts created by user |
| invitation_expired_for_user | boolean Invitation expired for user |
| group_user_activated_their_account | boolean User activated their account |
| no_remaining_organization_licences | boolean Organization does not have any remaining licenses |
| new_assistance_request | boolean New assistance request |
| id required | string |
| group_information_updated | boolean Group information has been updated |
| new_program_added | boolean New program has been added |
| group_admin_added | boolean User has been granted administrator role |
| group_user_changes | boolean Changes to users - added to org, removed from org, role changed |
| watch_my_contacts | boolean Updates and changes to contacts created by user |
| invitation_expired_for_user | boolean Invitation expired for user |
| group_user_activated_their_account | boolean User activated their account |
| no_remaining_organization_licences | boolean Organization does not have any remaining licenses |
| new_assistance_request | boolean New assistance request |
{- "group_information_updated": true,
- "new_program_added": true,
- "group_admin_added": true,
- "group_user_changes": true,
- "watch_my_contacts": true,
- "invitation_expired_for_user": true,
- "group_user_activated_their_account": true,
- "no_remaining_organization_licences": true,
- "new_assistance_request": true
}| id required | string |
| group_information_updated | boolean Group information has been updated |
| new_program_added | boolean New program has been added |
| group_admin_added | boolean User has been granted administrator role |
| group_user_changes | boolean Changes to users - added to org, removed from org, role changed |
| watch_my_contacts | boolean Updates and changes to contacts created by user |
| invitation_expired_for_user | boolean Invitation expired for user |
| group_user_activated_their_account | boolean User activated their account |
| no_remaining_organization_licences | boolean Organization does not have any remaining licenses |
| new_assistance_request | boolean New assistance request |
{- "group_information_updated": true,
- "new_program_added": true,
- "group_admin_added": true,
- "group_user_changes": true,
- "watch_my_contacts": true,
- "invitation_expired_for_user": true,
- "group_user_activated_their_account": true,
- "no_remaining_organization_licences": true,
- "new_assistance_request": true
}| id required | string |
| network_information_updated | boolean Network information has been updated |
| new_program_added | boolean New program has been added |
| network_admin_added | boolean User has been granted administrator role |
| network_user_changes | boolean Changes to users - added to org, removed from org, role changed |
| watch_my_contacts | boolean Updates and changes to contacts created by user |
| id required | string |
| network_information_updated | boolean Network information has been updated |
| new_program_added | boolean New program has been added |
| network_admin_added | boolean User has been granted administrator role |
| network_user_changes | boolean Changes to users - added to org, removed from org, role changed |
| watch_my_contacts | boolean Updates and changes to contacts created by user |
{- "network_information_updated": true,
- "new_program_added": true,
- "network_admin_added": true,
- "network_user_changes": true,
- "watch_my_contacts": true
}| id required | string |
| network_information_updated | boolean Network information has been updated |
| new_program_added | boolean New program has been added |
| network_admin_added | boolean User has been granted administrator role |
| network_user_changes | boolean Changes to users - added to org, removed from org, role changed |
| watch_my_contacts | boolean Updates and changes to contacts created by user |
{- "network_information_updated": true,
- "new_program_added": true,
- "network_admin_added": true,
- "network_user_changes": true,
- "watch_my_contacts": true
}| consent_token required | string |
| consent[signature_image] | string Base64 of the signature image |
{- "consent[signature_image]": "string"
}| referral_id required | string |
| group_id required | string |
| page | number The page of results to be returned. |
| per | number The number of records to be returned per page. |
| sord | string Enum: "asc" "desc" The order to sort the results. |
| sidx | string The attribute to sort the results by. |
| referral_id required | string |
| group_id required | string |
| page | number The page of results to be returned. |
| per | number The number of records to be returned per page. |
| sord | string Enum: "asc" "desc" The order to sort the results. |
| sidx | string The attribute to sort the results by. |
| id required | string |
| referral_id required | string |
| group_id required | string |
| document[title] required | string The name associated with the document |
| attach_to_id | string The ID of the object to change the document attachment to. |
{- "document[title]": "string",
- "attach_to_id": "string"
}| id required | string |
| referral_id required | string |
| group_id required | string |
| document[title] required | string The name associated with the document |
| attach_to_id | string The ID of the object to change the document attachment to. |
{- "document[title]": "string",
- "attach_to_id": "string"
}Filtered activity stream or timeline events are returned loosely based on the Activity Stream specification (activitystrea.ms).
Available verb values include: accept,
add, assign, close,
complete, create, delete,
deny, join, leave,
open, post, replace,
retract, save, send, and
update.
Use the verb, object, and target values to determine the event that occurred.
| referral_id required | string |
| group_id required | string |
| q[filter_names] | string Enum: "client_updates" "closed_records" "notes" "record_updates" "network_updates" "care_team" Name of filter to be appliied |
| page | number The page of results to be returned. |
| per | number The number of records to be returned per page. |
| sord | string Enum: "asc" "desc" The order to sort the results. |
| sidx | string The attribute to sort the results by. |
{- "q[filter_names]": "client_updates",
- "page": 0,
- "per": 0,
- "sord": "asc",
- "sidx": "string"
}| referral_id required | string |
| group_id required | string |
| user_id required | string The ID of the user to be set as the primary referral worker. |
{- "user_id": "string"
}| referral_id required | string |
| group_id required | string |
| user_id required | string The ID of the user to be set as the primary referral worker. |
{- "user_id": "string"
}Activity Stream or Timeline events are returned loosely based on the Activity Stream specification (activitystrea.ms).
Available verb values include: accept,
add, assign, close,
complete, create, delete,
deny, join, leave,
open, post, replace,
retract, save, send, and
update.
Use the verb, object, and target values to determine the event that occurred.
| referral_id required | string |
| group_id required | string |
| page | number The page of results to be returned. |
| per | number The number of records to be returned per page. |
| sord | string Enum: "asc" "desc" The order to sort the results. |
| sidx | string The attribute to sort the results by. |
| id required | string |
| form_id required | string |
| contact_id required | string |
| group_id required | string |
| data | Array of strings |
{- "data": [
- "string"
]
}| id required | string |
| form_id required | string |
| contact_id required | string |
| group_id required | string |
| data | Array of strings |
{- "data": [
- "string"
]
}| group_id required | string |
| q[text] required | string Text to search the index for. |
| q[include] | string Enum: "any" "cases_servicecase" "contact" "document" "interactions_base" "referrals_referral" An array of the types of models to include in the search. Defaults to "any". |
| v | string Enum: "v1" "v2" Indicates which version of search to execute. A value of "v2" indicates to use the "grouped" by type search type. |
{- "q[text]": "string",
- "q[include]": "any",
- "v": "v1"
}| group_id required | string |
| network_id required | string |
| q[coordinates][lon] required | number Longitude Coordinate |
| q[coordinates][lat] required | number Latitude Coordinate |
| q[text] required | string Text to search the index for. |
| q[service_type_ids] | Array of strings An array of service type IDs to filter on |
| q[distance] | string Either a distance w/ unit OR no distance IOT fetch |
| q[languages] | Array of strings An array of Program Lanugage names to filter on |
| q[accessibility_options] | Array of strings An array of Program Accessibility Option names to filter on |
| q[caters_to] | Array of strings An array of Program Catered To Population names to filter on |
| q[include_home_groups] | boolean Optionally include all groups for any provided |
| q[include_address_book] | boolean Optionally include address book groups with in network groups for the current group |
| q[only_address_book] | boolean Optionally only show address book groups for the current group |
| q[permitted_networks] | Array of strings Identifiers of networks that should be used to determine a referral scope. |
| q[force_sort_by_name] | boolean Optionally force ordering to be a-z even when distance constraint is used |
| page | number The page of results to be returned. |
| per | number The number of records to be returned per page. |
| sord | string Enum: "asc" "desc" The order to sort the results. |
| sidx | string The attribute to sort the results by. |
{- "q[coordinates][lon]": 0,
- "q[coordinates][lat]": 0,
- "q[text]": "string",
- "q[service_type_ids]": [
- "string"
], - "q[distance]": "string",
- "q[languages]": [
- "string"
], - "q[accessibility_options]": [
- "string"
], - "q[caters_to]": [
- "string"
], - "q[include_home_groups]": true,
- "q[include_address_book]": true,
- "q[only_address_book]": true,
- "q[permitted_networks]": [
- "string"
], - "q[force_sort_by_name]": true,
- "page": 0,
- "per": 0,
- "sord": "asc",
- "sidx": "string"
}| user[last_name] required | string User's last name. |
| user[first_name] required | string User's first name. |
| user[password_confirmation] required | string Confirmation of the user's password. |
| user[password] required | string User's preferred password. |
| user[email] required | string User's email address. |
| user[title] | string Enum: "Mr." "Miss" "Mrs." "Ms." "Dr." User's title. |
| user[middle_name_initial] | string User's middle name or initial. |
| user[suffix] | string Enum: "Jr." "Sr." "III" "IV" "V" "Esq." "Ph.D" User's suffix. |
| invitation[token] | string The invitation token used to connect the new user to other resources. |
{- "user[last_name]": "string",
- "user[first_name]": "string",
- "user[password_confirmation]": "string",
- "user[password]": "string",
- "user[email]": "string",
- "user[title]": "Mr.",
- "user[middle_name_initial]": "string",
- "user[suffix]": "Jr.",
- "invitation[token]": "string"
}| id required | string |
| user[profile][gender] required | string Enum: "male" "female" "undisclosed" "non-binary" "other" User's specified gender. |
| user[email] | string User's email address. |
| user[first_name] | string User's first name. |
| user[last_name] | string User's last name. |
| user[password] | string User's preferred password, only if changing it. |
| user[password_confirmation] | string Confirmation of user's preferred password, only if changing it. |
| user[profile][description] | string User's profile description or bio text. |
| user[title] | string User's work title or position name. |
{- "user[profile][gender]": "male",
- "user[email]": "string",
- "user[first_name]": "string",
- "user[last_name]": "string",
- "user[password]": "string",
- "user[password_confirmation]": "string",
- "user[profile][description]": "string",
- "user[title]": "string"
}| id required | string |
| user[profile][gender] required | string Enum: "male" "female" "undisclosed" "non-binary" "other" User's specified gender. |
| user[email] | string User's email address. |
| user[first_name] | string User's first name. |
| user[last_name] | string User's last name. |
| user[password] | string User's preferred password, only if changing it. |
| user[password_confirmation] | string Confirmation of user's preferred password, only if changing it. |
| user[profile][description] | string User's profile description or bio text. |
| user[title] | string User's work title or position name. |
{- "user[profile][gender]": "male",
- "user[email]": "string",
- "user[first_name]": "string",
- "user[last_name]": "string",
- "user[password]": "string",
- "user[password_confirmation]": "string",
- "user[profile][description]": "string",
- "user[title]": "string"
}Should be used to selectively invalidate active API tokens for the current
user. If successful, a 204 NO CONTENT response will be
returned.
| user_id required | string |
| token | string The token to destroy. |
{- "token": "string"
}| user_id required | string |
| page | number The page of results to be returned. |
| per | number The number of records to be returned per page. |
| sord | string Enum: "asc" "desc" The order to sort the results. |
| sidx | string The attribute to sort the results by. |
Accepts license agreement for a user to access the software. UU3-1307
Registers the user with the two-factor authentication service to enable 2FA
on the account. A successful registration will return a 201
CREATED response to the client.
| user_id required | string |
| phone_number[phone_number] required | string The user's mobile phone number. It must be SMS-capable. |
| phone_number[country_code] | number The user's country code. Defaults to 1, for United States. |
{- "phone_number[phone_number]": "string",
- "phone_number[country_code]": 0
}De-registers the user's account with the two-factor authentication
service and removes the 2FA setting for their Unite US account. Successful
de-registration will return a 204 NO CONTENT response.
| user_id required | string |
| assistance_request[requestor][phone_number][phone_number] required | string The phone number itself. Minimum 7 digits, only numbers will be stored. |
| assistance_request[requestor][address][country] required | string Country for the address. |
| assistance_request[requestor][address][state] required | string State or province for the address. |
| assistance_request[requestor][address][postal_code] required | string Postal or ZIP code for the address. Minimum 5 characters in length, maximum 15. |
| assistance_request[requestor][address][city] required | string City or town of the address. |
| assistance_request[requestor][address][line_1] required | string Address line 1 |
| assistance_request[requestor][address][address_type] required | string Enum: "home" "mailing" "work" "unknown" Type of address. |
| assistance_request[requestor][email_address][email_address] required | string A valid email address |
| assistance_request[requestor][last_name] required | string Requestor's last name. |
| assistance_request[requestor][first_name] required | string Requestor's first name. |
| assistance_request[service_type_id] required | string Identifier of the type of service requested. |
| assistance_request[description] required | string Full-text of the assistance request. |
| assistance_request[requestor][email] | string Requestor's email address. |
| assistance_request[requestor][date_of_birth] | number Unix (epoch) timestamp representing the requestor's date of birth. |
| assistance_request[requestor][gender] | string Enum: "male" "female" "undisclosed" "non-binary" "other" Requestor's specified gender. |
| assistance_request[requestor][citizenship] | string Enum: "us-citizen" "us-national" "lawful-permanent-resident" "other" "undisclosed" Requestor's specified citizenship. |
| assistance_request[requestor][ethnicity] | string Enum: "hispanic-or-latino" "not-hispanic-or-latino" "undisclosed" Requestor's specified ethnicity. |
| assistance_request[requestor][marital_status] | string Enum: "divorced" "domestic_partner" "married-civil-union" "single/never-married" "separated" "undisclosed" "widowed" Requestor's specified marital status. |
| assistance_request[requestor][race] | string Enum: "american-indian-alaska-native" "asian" "black-african-american" "native-hawaiian-or-pacific-islander" "other-race" "undisclosed" "white" Requestor's specified race. |
| assistance_request[requestor][email_address][is_primary] | boolean Is this email address the primary one for the requestor. |
| assistance_request[requestor][preferred_first_name] | string Requestor's preferred first name. |
| assistance_request[requestor][title] | string Enum: "Mr." "Miss" "Mrs." "Ms." "Dr." Requestor's title. |
| assistance_request[requestor][middle_name_initial] | string Requestor's middle name or initial. |
| assistance_request[requestor][suffix] | string Enum: "Jr." "Sr." "III" "IV" "V" "Esq." "Ph.D" Requestor's suffix. |
| assistance_request[requestor][address][line_2] | string Additional address details, ex. apartment, suite, etc. |
| assistance_request[requestor][address][is_mailing_address] | boolean Is this a mailing address. |
| assistance_request[requestor][phone_number][is_primary] | boolean Is this phone number the requestor's primary requestor number. |
| assistance_request[requestor][phone_number][phone_type] | string Enum: "mobile" "home" "work" "fax" "unknown" Type of phone number. |
| assistance_request[requestor][phone_number][can_sms] | boolean Can this phone number receive SMS? |
| assistance_request[requestor][phone_number][country_code] | string Country code for the phone number. Defaults to 1, if not specified. |
| assistance_request[requestor][military][affiliation] | string Enum: "military_member_or_veteran" "spouse" "widow" "family_member" "caregiver" "prefer_not_to_disclose" Military affiliation |
| assistance_request[requestor][military][current_status] | string Enum: "active_duty" "national_guard" "reserve" "retiree" "veteran" "prefer_not_to_disclose" Current military status |
| assistance_request[requestor][military][currently_transitioning] | string Enum: "yes_12mos_before" "yes_12mos_after" "no" "prefer_not_to_disclose" Is the requestor currently transitioning? |
| assistance_request[requestor][military][at_least_one_day_active_duty] | string Enum: "yes" "no" "prefer_not_to_disclose" Has at least one day of active duty outside of basic training? |
| assistance_request[requestor][military][branch] | string Enum: "air_force" "army" "coast_guard" "marines" "navy" "prefer_not_to_disclose" Branch of service |
| assistance_request[requestor][military][service_era] | string Enum: "post_911" "persian_gulf" "post_vietnam" "vietnam" "post_korean" "korean_war" "pre_korean" "ww2" "merchant_marine" "ww1" "prefer_not_to_disclose" Service era |
| assistance_request[requestor][military][entry_date] | number Date of entry |
| assistance_request[requestor][military][exit_date] | number Date of exit |
| assistance_request[requestor][military][deployed] | string Enum: "yes" "no" "prefer_not_to_disclose" Deployed? |
| assistance_request[requestor][military][deployment_starts_at] | number Deployment start date |
| assistance_request[requestor][military][deployment_ends_at] | number Deployment end date |
| assistance_request[requestor][military][discharge_type] | string Enum: "honorable" "general" "other_than_honorable" "bad_conduct" "dishonorable" "uncharacterized" "other" "prefer_not_to_disclose" Discharge type |
| assistance_request[requestor][military][discharged_due_to_disability] | string Enum: "yes" "no" "prefer_not_to_disclose" Discharged or retired from military service for a disability incurred in the line of duty? |
| assistance_request[requestor][military][service_connected_disability] | string Enum: "yes" "no" "prefer_not_to_disclose" Has VA-rated Service-Connected Disability? |
| assistance_request[requestor][military][service_connected_disability_rating] | string Enum: "0" "10" "20" "30" "40" "50" "60" "70" "80" "90" "100" "prefer_not_to_disclose" Service-Connected Disability Rating |
| assistance_request[requestor][military][proof_of_veteran_status] | string Enum: "yes" "no" "prefer_not_to_disclose" Have proof of veteran status? |
| assistance_request[requestor][military][proof_type] | string Enum: "dd214" "va_id" "statement_of_service" "retiree_id" "drivers_license" "military_id" "other" "prefer_not_to_disclose" Proof type |
| assistance_request[requestor][form_response][form_id] | string The identifier of the assistance request form. |
| assistance_request[requestor][form_response][data] | Array of strings |
| assistance_request[consent][signature_image] | string Base64 of the signature image |
{- "assistance_request[requestor][phone_number][phone_number]": "string",
- "assistance_request[requestor][address][country]": "string",
- "assistance_request[requestor][address][state]": "string",
- "assistance_request[requestor][address][postal_code]": "string",
- "assistance_request[requestor][address][city]": "string",
- "assistance_request[requestor][address][line_1]": "string",
- "assistance_request[requestor][address][address_type]": "home",
- "assistance_request[requestor][email_address][email_address]": "string",
- "assistance_request[requestor][last_name]": "string",
- "assistance_request[requestor][first_name]": "string",
- "assistance_request[service_type_id]": "string",
- "assistance_request[description]": "string",
- "assistance_request[requestor][email]": "string",
- "assistance_request[requestor][date_of_birth]": 0,
- "assistance_request[requestor][gender]": "male",
- "assistance_request[requestor][citizenship]": "us-citizen",
- "assistance_request[requestor][ethnicity]": "hispanic-or-latino",
- "assistance_request[requestor][marital_status]": "divorced",
- "assistance_request[requestor][race]": "american-indian-alaska-native",
- "assistance_request[requestor][email_address][is_primary]": true,
- "assistance_request[requestor][preferred_first_name]": "string",
- "assistance_request[requestor][title]": "Mr.",
- "assistance_request[requestor][middle_name_initial]": "string",
- "assistance_request[requestor][suffix]": "Jr.",
- "assistance_request[requestor][address][line_2]": "string",
- "assistance_request[requestor][address][is_mailing_address]": true,
- "assistance_request[requestor][phone_number][is_primary]": true,
- "assistance_request[requestor][phone_number][phone_type]": "mobile",
- "assistance_request[requestor][phone_number][can_sms]": true,
- "assistance_request[requestor][phone_number][country_code]": "string",
- "assistance_request[requestor][military][affiliation]": "military_member_or_veteran",
- "assistance_request[requestor][military][current_status]": "active_duty",
- "assistance_request[requestor][military][currently_transitioning]": "yes_12mos_before",
- "assistance_request[requestor][military][at_least_one_day_active_duty]": "yes",
- "assistance_request[requestor][military][branch]": "air_force",
- "assistance_request[requestor][military][service_era]": "post_911",
- "assistance_request[requestor][military][entry_date]": 0,
- "assistance_request[requestor][military][exit_date]": 0,
- "assistance_request[requestor][military][deployed]": "yes",
- "assistance_request[requestor][military][deployment_starts_at]": 0,
- "assistance_request[requestor][military][deployment_ends_at]": 0,
- "assistance_request[requestor][military][discharge_type]": "honorable",
- "assistance_request[requestor][military][discharged_due_to_disability]": "yes",
- "assistance_request[requestor][military][service_connected_disability]": "yes",
- "assistance_request[requestor][military][service_connected_disability_rating]": "0",
- "assistance_request[requestor][military][proof_of_veteran_status]": "yes",
- "assistance_request[requestor][military][proof_type]": "dd214",
- "assistance_request[requestor][form_response][form_id]": "string",
- "assistance_request[requestor][form_response][data]": [
- "string"
], - "assistance_request[consent][signature_image]": "string"
}| assistance_request_id required | string |
| group_id required | string |
| exited_at required | string The date the assistance request was closed |
| outcome_id required | string The id of the outcome this closing is associated with |
| resolved required | string Enum: "true" "false" The status of the case |
| note | string A note pertaining to the closing |
{- "exited_at": "string",
- "outcome_id": "string",
- "resolved": "true",
- "note": "string"
}| assistance_request_id required | string |
| group_id required | string |
| exited_at required | string The date the assistance request was closed |
| outcome_id required | string The id of the outcome this closing is associated with |
| resolved required | string Enum: "true" "false" The status of the case |
| note | string A note pertaining to the closing |
{- "exited_at": "string",
- "outcome_id": "string",
- "resolved": "true",
- "note": "string"
}| service_case_id required | string |
| contact_id required | string |
| group_id required | string |
| outcome_id required | string The id of the outcome this closing is associated with |
| status required | string Enum: "resolved" "unresolved" The status of the case; either |
| note | string A note pertaining to the closing |
{- "outcome_id": "string",
- "status": "resolved",
- "note": "string"
}| service_case_id required | string |
| contact_id required | string |
| group_id required | string |
| outcome_id required | string The id of the outcome this closing is associated with |
| status required | string Enum: "resolved" "unresolved" The status of the case; either |
| note | string A note pertaining to the closing |
{- "outcome_id": "string",
- "status": "resolved",
- "note": "string"
}